Django REST framework 技术文档

1. 安装指南

首先，确保您的环境中已经安装了 Python 3.8 或更高版本以及 Django 4.2, 5.0, 或 5.1。推荐使用最新版本的 Python 和 Django。

使用 pip 安装 Django REST framework：

pip install djangorestframework

然后，在您的 Django 项目的 settings.py 文件中，将 'rest_framework' 添加到 INSTALLED_APPS 列表中：

INSTALLED_APPS = [
    ...
    'rest_framework',
]

2. 项目的使用说明

Django REST framework 是一个强大的工具包，用于构建 Web APIs。以下是如何快速开始使用这个框架的步骤：

1. 创建项目：使用 Django 的命令创建一个新项目。

   pip install django
   django-admin startproject example .
   

2. 迁移数据库：执行数据库迁移以创建必要的表。

   ./manage.py migrate
   

3. 创建超级用户：创建一个超级用户以便于管理。

   ./manage.py createsuperuser
   

4. 编辑 urls.py：在项目目录下的 urls.py 文件中配置 URL 路由。

   from django.contrib import admin
   from django.urls import path, include
   from rest_framework import routers, serializers, viewsets
   from django.contrib.auth.models import User
   
   # Serializers define the API representation.
   class UserSerializer(serializers.HyperlinkedModelSerializer):
       class Meta:
           model = User
           fields = ['url', 'username', 'email', 'is_staff']
   
   # ViewSets define the view behavior.
   class UserViewSet(viewsets.ModelViewSet):
       queryset = User.objects.all()
       serializer_class = UserSerializer
   
   # Routers provide a way of automatically determining the URL conf.
   router = routers.DefaultRouter()
   router.register(r'users', UserViewSet)
   
   # Wire up our API using automatic URL routing.
   urlpatterns = [
       path('', include(router.urls)),
       path('admin/', admin.site.urls),
       path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
   ]
   

5. 配置 settings.py：在 settings.py 文件中配置 REST framework。

   REST_FRAMEWORK = {
       'DEFAULT_PERMISSION_CLASSES': [
           'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly',
       ]
   }
   

6. 运行服务器：启动 Django 开发服务器。

   ./manage.py runserver
   

现在，您可以在浏览器中打开 http://127.0.0.1:8000/，查看新的 'users' API。

3. 项目API使用文档

Django REST framework 提供了丰富的 API 功能，包括序列化、视图、权限、认证等。以下是一些基础的使用示例：

• 获取用户列表：

  curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/
  

• 创建新用户：

  curl -X POST -d username=new -d email=[e-mail] -d is_staff=false -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/
  

更多 API 使用和配置细节，请参考官方文档。

4. 项目安装方式

如上所述，使用 pip 是安装 Django REST framework 最简单的方式：

pip install djangorestframework

确保将 'rest_framework' 添加到您的 Django 项目的 INSTALLED_APPS 中。

以上就是关于 Django REST framework 的技术文档，希望对您有所帮助。如果您有任何问题或需要进一步的帮助，请参考官方文档或加入相关社区进行讨论。