一.下载安装
pip install flasgger==0.9.7.1
二.基本使用
from flask import Flask, jsonify
from flasgger import Swaggerapp = Flask(__name__)
swagger = Swagger(app)@app.route('/colors/<palette>/')
def colors(palette):"""Example endpoint returning a list of colors by paletteThis is using docstrings for specifications.---parameters:- name: palettein: pathtype: stringenum: ['all', 'rgb', 'cmyk']required: truedefault: alldefinitions:Palette:type: objectproperties:palette_name:type: arrayitems:$ref: '#/definitions/Color'Color:type: stringresponses:200:description: A list of colors (may be filtered by palette)schema:$ref: '#/definitions/Palette'examples:rgb: ['red', 'green', 'blue']"""all_colors = {'cmyk': ['cyan', 'magenta', 'yellow', 'black'],'rgb': ['red', 'green', 'blue']}if palette == 'all':result = all_colorselse:result = {palette: all_colors.get(palette)}return jsonify(result)app.run(debug=True)
三.打开文档
http://127.0.0.1:5000/apidocs