Django 自动生成文档

老是忘 记录下
https://blog.csdn.net/smartwu_sir/article/details/80213489

coreapi

https://blog.csdn.net/qq_34400745/article/details/104001721

pip install coreapi



REST_FRAMEWORK = {
    # 指定用于支持coreapi的Schema
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}





from rest_framework.documentation import include_docs_urls
urlpatterns += [
    url('api/', include_docs_urls(title="接口测试平台API文档",
                                    description="这个是接口平台的文档"
                                    ))

]

django_rest_swagger

https://blog.csdn.net/m0_37193944/article/details/89497333

https://www.jianshu.com/p/f26c9160ab43

pip install django-rest-swagger

进入 seeting.py 添加 rest_framework_swagger 应用


from rest_framework_swagger.renderers import SwaggerUIRenderer, OpenAPIRenderer
schema_view = get_schema_view(title='接口文档', renderer_classes=[OpenAPIRenderer, SwaggerUIRenderer])

urlpatterns += [
    url(r'swagger/', schema_view),
]

字段注释 在model或者 serializer 字段添加

help_text="xxxx"

class UserViewSet(ModelViewSet):
    """
    list:
    用户列表
    create: 创建用户
    update: 修改用户属性
    delete:逻辑删除用户
    retrieve:查看某个用户信息
    partial_update:修改用户某个属性
    hh:测试action

    """
    queryset = User.objects.all()
    serializer_class = UserSerializer
    permission_classes = [AllowAny]
    # schema = CustomSchema()

    @action(methods=['get'], detail=False)
    def hh(self, reuqest):
        # """
        # 测试
        # :param reuqest:
        # :return:
        # """
        return JsonResponse({'kk':'123'})


class Model(APIView):

    def get(self, request):
        """
        测试 Apiview
        :param request:
        :return:
        """
        return JsonResponse({'msg':'ok'})

最后

以上就是开朗羊为你收集整理的Django 自动生成文档的全部内容，希望文章能够帮你解决Django 自动生成文档所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。