Django接口文档

Django接口文档

一 Django REST Framework自带的接口文档

https://www.django-rest-framework.org/community/3.6-announcement/#interactive-api-documentation

二 django-rest-swagger

swagger简介

Swagger：是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是使客户端和文件系统源代码作为服务器以同样的速度来更新。当接口有变动时，对应的接口文档也会自动更新。

Swagger能成为最受欢迎的REST APIs文档生成工具之一，有以下几个原因：

• Swagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。
• Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
• Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
• Swagger 有一个强大的社区，里面有许多强悍的贡献者。

1 安装 django-rest-swagger

pip install django-rest-swagger

2 在settings.py中配置

INSTALLED_APPS = [
    ...
    'rest_framework_swagger',  # swagger接口文档管理
    ...
]

注意：可在settings.py中自定义swagger 配置项，详细见参考文献；

3 在urls.py中配置

from rest_framework.schemas import get_schema_view
from rest_framework_swagger.renderers import SwaggerUIRenderer, OpenAPICodec
schema_view = get_schema_view(title='新业务后端接口', renderer_classes=[SwaggerUIRenderer, OpenAPICodec])

urlpatterns = [
    url(r'swagger/', schema_view, name='swagger'),  # swagger接口文档管理
]

django-rest-swagger提供了两个有用的渲染器：SwaggerUIRenderer 和 OpenAPIRenderer。

参考：
https://www.jianshu.com/p/dc77f652e7d7
https://blog.csdn.net/sinat_41622641/article/details/81636682
https://www.django-rest-framework.org/api-guide/schemas/#schemagenerator