利用flasgger生成FlaskAPI文档

简介: 利用flasgger生成FlaskAPI文档

githubhttps://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/

访问文档

image.png

参考:

利用swagger模块开发flask的api接口帮助文档

相关文章
|
API Python
利用flasgger生成FlaskAPI文档
利用flasgger生成FlaskAPI文档
475 0
利用flasgger生成FlaskAPI文档
|
10月前
Adoc文档的使用
Adoc文档的使用
46 0
|
移动开发 JavaScript 开发工具
less文档和安装
less文档和安装
130 0
|
JSON API 数据格式
关于文档的API操作( 添加文档和获取文档)
关于文档的API操作( 添加文档和获取文档)
|
前端开发 JavaScript Apache
LESS文档
LESS文档
341 0
|
XML JavaScript .NET
|
数据安全/隐私保护