使用apidoc管理RESTful風(fēng)格Flask項(xiàng)目接口文檔方法

更新時間：2018年02月07日 10:01:37 作者：lynnyq

下面小編就為大家分享一篇使用apidoc管理RESTful風(fēng)格Flask項(xiàng)目接口文檔方法，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧

使用apidoc管理RESTful風(fēng)格Flask項(xiàng)目接口文檔方法

apidoc項(xiàng)目地址

flask擴(kuò)展包地址

文檔示例地址

1.安裝nodejs

sudo apt-get install nodejs
sudo apt install nodejs-legacy
sudo apt install npm

2.安裝apidoc

npm install apidoc -g

3.Flask擴(kuò)展包安裝

pip install flask-apidoc

4.添加擴(kuò)展包到Flask項(xiàng)目

依賴環(huán)境

flask>=0.10.1
flask_script>=2.0.5

manage.py項(xiàng)目啟動腳本配置

from views import app
from flask_apidoc.commands import GenerateApiDoc
from flask_script import Manager
manager = Manager(app)
manager.add_command('apidoc', GenerateApiDoc())
if __name__ == "__main__":
 manager.run()

apidoc.json配置

必須在項(xiàng)目根目錄下建立apidoc.json配置文件

{
 "name": "Flask REST API",
 "version": "1.0.0",
 "description": "A Flask REST API example",
 "title": "A Flask REST API example",
 "url" : "http://localhost:5000"
}

視圖函數(shù)文檔注釋說明示例

# -*- coding: utf-8 -*-
from flask import Flask
from flask_apidoc import ApiDoc
app = Flask(__name__)
doc = ApiDoc(app=app)

@app.route('/users', methods=['POST'])
def register():
 """
 @api {post} /api/v1.0/users 注冊
 @apiVersion 1.0.0
 @apiName register_user
 @apiGroup Users
 @apiParam {String} mobile  (必須) 用戶手機(jī)號
 @apiParam {String} password (必須) 用戶密碼
 @apiParam {String} sms_code (必須) 用戶短信驗(yàn)證碼
 @apiParamExample {json} Request-Example:
  {
   mobile: "13970512239",
   password: "123456",
   sms_code: "907896"
  }
 @apiSuccess (回參) {int} user_id 用戶注冊id
 @apiSuccess (回參) {String} name 用戶昵稱
 @apiSuccess (回參) {String} mobile 用戶注冊手機(jī)號
 @apiSuccess (回參) {String} avatar 用戶頭像地址
 @apiSuccess (回參) {String} create_time 用戶創(chuàng)建時間
 @apiSuccessExample {json} Success-Response:
  {
   "errno":0,
   "errmsg":"注冊成功！",
   "data": {
    "user_id": 1,
    "name": "lynnyq",
    "mobile": "13813888888",
    "avatar": "http://p3ifu3dwc.bkt.clouddn.com/FjuAwxmcCtiud_nOZ",
    "create_time": "2010-1-1 12:12:12"
   }
  }
 @apiErrorExample {json} Error-Response:
  {
   "errno":4001,
   "errmsg":"數(shù)據(jù)庫查詢錯誤！"
  }
 """
 pass

5.生成RESTful風(fēng)格接口文檔