使用apidoc管理RESTful風格Flask項目接口文檔

使用apidoc管理RESTful風格Flask項目接口文檔

apidoc項目地址

flask擴展包地址

文檔示例地址

1.安裝nodejs

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

2.安裝apidoc

npm install apidoc -g

3.Flask擴展包安裝

pip install flask-apidoc

4.添加擴展包到Flask項目

• 依賴環境

flask>=0.10.1
flask_script>=2.0.5

• manage.py項目啓動腳本配置

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配置

必須在項目根目錄下建立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"
}

• 視圖函數文檔註釋說明示例

# -*- 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      (必須)    用戶手機號
    @apiParam {String}  password    (必須)    用戶密碼
    @apiParam {String}  sms_code    (必須)    用戶短信驗證碼
    @apiParamExample {json} Request-Example:
        {
            mobile: "13970512239",
            password: "123456",
            sms_code: "907896"
        }

    @apiSuccess (回參) {int} user_id  用戶註冊id
    @apiSuccess (回參) {String} name  用戶暱稱
    @apiSuccess (回參) {String} mobile  用戶註冊手機號
    @apiSuccess (回參) {String} avatar  用戶頭像地址
    @apiSuccess (回參) {String} create_time  用戶創建時間
    @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":"數據庫查詢錯誤！"
        }

    """
    pass

5.生成RESTful風格接口文檔

python manage.py apidoc

文檔默認生成在項目根目錄下的static/docs文件夾下

6.接口文檔頁面效果