希望你使用Django创建一个最小限的REST框架应用程序

2 年 ago

清, 扬

2 minutes

创建最小限的RESTful API应用程序的步骤

请详细说明使用Django REST框架创建最小化RESTful API应用的步骤。请按照以下步骤进行操作。

创建Django应用：
在项目内创建新的Django应用。
cd restapi_project
python manage.py startapp testapp

创建序列化器：
在testapp内创建serializers.py文件，并定义序列化器如下：
from rest_framework import serializers

class TestSerializer(serializers.Serializer):
data = serializers.CharField(max_length=100)

创建视图：
在testapp内创建views.py文件，并定义视图如下：
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status

class TestView(APIView):
def get(self, request):
return Response(“GET OK”)

def post(self, request, *args, **kwargs):
data = request.data[‘message’]
return Response(data)

设置URL模式：
在testapp内创建urls.py文件，将视图和URL关联起来。
from django.urls import path
from .views import TestView

urlpatterns = [
path(‘api/test/’, TestView.as_view(), name=’test-api’),
]

更新项目URL设置：
编辑项目的urls.py文件，包含应用的URL。
from django.contrib import admin
from django.urls import path, include

urlpatterns = [
path(‘admin/’, admin.site.urls),
path(”, include(‘testapp.urls’)),
]

禁用可浏览的API页面：
在settings.py文件中，在REST_FRAMEWORK部分添加以下设置以禁用可浏览的API页面。
REST_FRAMEWORK = {
‘DEFAULT_RENDERER_CLASSES’: [
‘rest_framework.renderers.JSONRenderer’,
],
‘DEFAULT_PARSER_CLASSES’: [
‘rest_framework.parsers.JSONParser’,
],
}

通过这样做，仅使用JSON格式的响应。

python manage.py runserver

在访问http://localhost:8000/api/test/时，创建一个RESTful API，当使用GET请求时，会返回”GET OK”，当使用POST请求时，会将发送的数据原封不动地返回。

按照这个步骤，您可以创建一个最小限的Django REST框架应用程序，并可以根据需要进行自定义和扩展，实现各种API。

要在Django中允许CORS（跨域资源共享），

要在Django中允许CORS（跨域资源共享），通常会使用django-cors-headers包来进行设置。请按照以下步骤进行设置。

添加配置：
在settings.py文件中，将’corsheaders’添加到INSTALLED_APPS。
INSTALLED_APPS = [
# …
‘corsheaders’,
]

添加中间件：
在MIDDLEWARE列表中，在CorsMiddleware之前添加’corsheaders.middleware.CorsMiddleware’。
MIDDLEWARE = [
# …
‘corsheaders.middleware.CorsMiddleware’,
# …
]

自定义CORS配置：
在settings.py文件中，添加CORS配置。以下是基本示例，但您可以根据需要自定义配置。
CORS_ALLOWED_ORIGINS = [
“http://localhost:3000”, # 根据React应用程序的地址进行相应更改
]

# 您可以添加其他CORS配置，根据需要进行更改

注意事项：
请在CORS_ALLOWED_ORIGINS列表中添加允许访问的来源（域名）。

请根据React应用程序的地址进行相应更改，http://localhost:3000的部分。

通过这个设置，Django项目将允许CORS，接受指定来源的访问。在修改CORS设置后，请不要忘记重新启动Django服务器以使设置生效。

requirements.txt 文件

asgiref==3.7.2
Django==4.2.4
django-cors-headers==4.2.0
djangorestframework==3.14.0
pytz==2023.3
sqlparse==0.4.4
typing_extensions==4.7.1
tzdata==2023.3

连接.bat

echo "--------- Django server run!!!"
cd restapi_project
call venv/Scripts/activate.bat
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
python manage.py runserver

希望你使用Django创建一个最小限的REST框架应用程序

相关页面

创建最小限的RESTful API应用程序的步骤

要在Django中允许CORS（跨域资源共享），

requirements.txt 文件

连接.bat

.gitignore 文件