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'))
]
改進(jìn)為: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)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市播揪,隨后出現(xiàn)的幾起案子勤揩,更是在濱河造成了極大的恐慌帅涂,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,826評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件杆勇,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機趟畏,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,968評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來滩租,“玉大人赋秀,你說我怎么就攤上這事÷上耄” “怎么了猎莲?”我有些...
    開封第一講書人閱讀 164,234評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長技即。 經(jīng)常有香客問我著洼,道長,這世上最難降的妖魔是什么而叼? 我笑而不...
    開封第一講書人閱讀 58,562評論 1 293
  • 正文 為了忘掉前任身笤,我火速辦了婚禮,結(jié)果婚禮上葵陵,老公的妹妹穿的比我還像新娘液荸。我一直安慰自己,他們只是感情好埃难,可當(dāng)我...
    茶點故事閱讀 67,611評論 6 392
  • 文/花漫 我一把揭開白布莹弊。 她就那樣靜靜地躺著涤久,像睡著了一般。 火紅的嫁衣襯著肌膚如雪忍弛。 梳的紋絲不亂的頭發(fā)上响迂,一...
    開封第一講書人閱讀 51,482評論 1 302
  • 那天,我揣著相機與錄音细疚,去河邊找鬼蔗彤。 笑死,一個胖子當(dāng)著我的面吹牛疯兼,可吹牛的內(nèi)容都是我干的然遏。 我是一名探鬼主播,決...
    沈念sama閱讀 40,271評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼吧彪,長吁一口氣:“原來是場噩夢啊……” “哼待侵!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起姨裸,我...
    開封第一講書人閱讀 39,166評論 0 276
  • 序言:老撾萬榮一對情侶失蹤秧倾,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后傀缩,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體那先,經(jīng)...
    沈念sama閱讀 45,608評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,814評論 3 336
  • 正文 我和宋清朗相戀三年赡艰,在試婚紗的時候發(fā)現(xiàn)自己被綠了售淡。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,926評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡慷垮,死狀恐怖揖闸,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情料身,我是刑警寧澤楔壤,帶...
    沈念sama閱讀 35,644評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站惯驼,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏递瑰。R本人自食惡果不足惜祟牲,卻給世界環(huán)境...
    茶點故事閱讀 41,249評論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望抖部。 院中可真熱鬧说贝,春花似錦、人聲如沸慎颗。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,866評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至傲宜,卻和暖如春运杭,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背函卒。 一陣腳步聲響...
    開封第一講書人閱讀 32,991評論 1 269
  • 我被黑心中介騙來泰國打工辆憔, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人报嵌。 一個月前我還...
    沈念sama閱讀 48,063評論 3 370
  • 正文 我出身青樓虱咧,卻偏偏與公主長得像,于是被迫代替她去往敵國和親锚国。 傳聞我的和親對象是個殘疾皇子腕巡,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,871評論 2 354