利用flasgger生成FlaskAPI文檔

github： https://github.com/flasgger/flasgger 安裝

pip install flasgger      

示例

# -*- coding: utf-8 -*-
from flask import Flask, jsonify
from flasgger import Swagger

app = Flask(__name__)
swagger = Swagger(app)


@app.route("/getInfo/<int:uid>")
def get_info(uid):
    """擷取使用者資訊

    ---
    parameters:
      - name: uid
        in: path
        type: int
        required: true
        default: 1
        description: 使用者id

    responses:
      200:
        description: 傳回使用者資訊
        examples:
            {
                code: 0,
                msg: "ok",
                data:
                    {
                        name: "Tom",
                        uid: 1
                    },
            }
    """
    data = {
        "code": 0,
        "msg": "ok",
        "data": {
            "name": "Tom",
            "uid": uid
        }
    }

    return jsonify(data)


if __name__ == '__main__':
    app.run(debug=True)
      

http://127.0.0.1:5000/apidocs/

通路文檔

參考:

利用swagger子產品開發flask的api接口幫助文檔