Django Rest Framework 自定义 POST URL 端点，使用 Swagger 或其他文档定义参数request.POST

问题描述

以前在 Django 1.11 中，我以这种方式定义了 Django REST API：

在 url.py

url(r'^api/test_token$',api.test_token,name='test_token'),

在 api.py 中

@api_view(['POST'])
def test_token(request):
    # ----- YAML below for Swagger -----
    """
    description: test_token
    parameters:
      - name: token
        type: string
        required: true
        location: form       
    """
    token = request.POST['token']

    return Response("test_token success",status=status.HTTP_200_OK)

现在我要迁移到 Django 3.1.5，我想知道如何使用 Django Rest Framework (DRF) 以相同的方式实现上述目标。在上述特定情况下，POST API“test_token”接受一个参数。并生成 swagger/redoc 等 API 文档（可用于测试 API）

一些注意事项：

此处还指出 django-rest-swagger 已于 2019 年 6 月弃用 django-rest-swagger UI doesn't have form for POST request body (function based view)
需要注意的是，它使用 request.POST（表单数据）作为参数 https://www.django-rest-framework.org/tutorial/2-requests-and-responses/
在 Django 1.11.x 中，我使用了这个 swagger_schema.py - https://gist.github.com/axilaris/b7152215a76f6f1f5ffca0436991328d

我如何在 Django 3.x 上实现这个？（如标题所示：带有 Swagger 或其他文档定义的参数的 Django Rest Framework 自定义 POST URL 端点）

更新：

我认为这里有某种形式的解决方案： https://github.com/tfranzel/drf-spectacular/issues/279

因为我有很多使用@api_view 的 API，所以更改文档字符串到装饰器 @extend_schema 可能是最简单的迁移路径。我希望有人可以为使用@extend_schema 的转换提供有关 url.py 的指导。这是为了实现 url 端点和 swagger。谢谢。

这是我在 drf-spectacular 中得到的最接近的

@extend_schema( 
 parameters=[OpenApiParameter( 
     name='token',type={'type': 'string'},location=OpenApiParameter.QUERY,required=False,style='form',explode=False,)],responses=OpenApiTypes.OBJECT,) 
@api_view(['POST'])
def test_api(request):
    # ----- YAML below for Swagger -----
    """
    description: test_api
    parameters:
      - name: token
        type: string
        required: true
        location: form       
    """
    token = request.POST['token']
    
    return Response("success test_api:" + token,status=status.HTTP_200_OK)

它给出了这个（这是不正确的），注意令牌查询

curl -X POST "http://localhost:8000/api/test_token/?token=hello" -H  "accept: application/json" -H  "X-CSRFToken: JyPOSAQx04LK0aM8IUgUmkruALSNwRbeYDzUHBhCjtXafC3tnHRFsxvyg5SgMLhI" -d ""

而不是 POST 输入参数（如何获得？）

curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' --header 'X-CSRFToken: aExHCSwrRyStDiOhkk8Mztfth2sqonhTkUFaJbnXSFKXCynqzDQEzcRCAufYv6MC' -d 'token=hello' 'http://localhost:8000/api/test_token/

解决方案：

url.py

from drf_yasg.utils import swagger_auto_schema 

from rest_framework.response import Response
from rest_framework import status

from rest_framework.decorators import parser_classes
from rest_framework.parsers import FormParser

token = openapi.Parameter('token',openapi.IN_FORM,type=openapi.TYPE_STRING,required=True)
something = openapi.Parameter('something',type=openapi.TYPE_INTEGER,required=False)
@swagger_auto_schema(
    method="post",manual_parameters=[token,something],operation_id="token_api"
)
@api_view(['POST'])
# this is optional and insures that the view gets formdata
@parser_classes([FormParser])
def token_api(request):
    token = request.POST['token']
    something = request.POST['something']
    
    return Response("success test_api:" + token + something,status=status.HTTP_200_OK)


schema_view = get_schema_view(
   openapi.Info(
      title="Snippets API",default_version='v1',description="Test description",terms_of_service="https://www.google.com/policies/terms/",contact=openapi.Contact(email="[email protected]"),license=openapi.License(name="BSD License"),),public=True,permission_classes=[permissions.AllowAny],)


urlpatterns = [
    
    path('token_api',token_api,name='token_api'),path('swagger/',schema_view.with_ui('swagger',cache_timeout=0),name='schema-swagger-ui'),] + required_urlpatterns

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）

django django-rest-framework redoc rest swagger