原文見 :?https://chen-yijie.blogspot.com/2018/10/django-restframework-document.html
由于項(xiàng)目打算基于Django故首先調(diào)研了幾個(gè)與Django相關(guān)的
1.django restframework自帶文檔模塊 基于coreapi
- 支持代碼內(nèi)文檔自動(dòng)生成蚌讼，格式較為簡(jiǎn)單
- 查看文檔時(shí)可以進(jìn)行測(cè)試并生成客戶端代碼(py,js)
2. 使用第三方的?Django REST Swagger基于swagger UI
- 使用方法類似與django restframework自帶文檔模塊焰薄，都是支持自動(dòng)掃描與手動(dòng)描述
- UI有一點(diǎn)差異
3.?Swagger Editor：通用的文檔編輯與測(cè)試框架
- 文檔驅(qū)動(dòng)的服務(wù)端與客戶端開發(fā)许赃，支持自動(dòng)生成服務(wù)端與客戶端代碼，只需要補(bǔ)充業(yè)務(wù)邏輯代碼，支持?jǐn)?shù)十種語言與框架(似乎沒有django)
- 使用yaml或者json作為文檔描述
案例可見http://editor.swagger.io/#
4.drfdocs?: 適配于django restframework, 看上去類似于官方文檔模塊
[參考鏈接]
