REST的API-文檔

  • 我們需要api文檔來敘述api的內(nèi)容
  • 我們會經(jīng)常做出改動
  • 我們需要一個api文檔來幫助檢測功能


coreapi

  • 好看的api文檔
  • pip install coreapi

綱要文檔
# urls.py
from rest_framework.schemas import get_schema_view
    
urlpattern = [
    url(r'^schema/', get_schema_view(title='文檔-API'))
]
改進為:API文檔
from rest_framework.documentation import include_docs_urls

urlpattren = [
    url(r'docs/', include_docs_urls(title='醫(yī)院-API'))
]


Swagger

  • 多編程語言通用的API文檔
  • pip install django-rest-swagger

# setting.py
INSTALLED_APPS = [
    ...
    'rest_framework_swagger'
]

# urls.py
from rest_framework_swagger.views import get_swagger_view
urlpatterns = [
    url(r'docs/', get_swagger_view(title='病人-API'))
]
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容