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