基于flask实现swagger在线api文档

1. 引言：
   • Flask是一款流行的Python实现的Web开发微框架；
   • Swagger是一款Restful接口的文档在线自动生成+功能测试功能软件
2. 支持Python+Flask的Swagger库不少，有flask-swag，flask-swagger，flasgger
3. flask的debug模式会额外开启一个进程，这个进程负责监控代码是否发生变化，即DEBUG模式下flask多开一个线程来监视项目的变化，因此可以打开debug模式时，发生端口被占用，可以设置 use_reloader=False
4. 通过包flask-swagger获取独立的docstring文件test.yaml，参考https://github.com/getsling/flask-swagger
5. 通过包flask_swagger_ui添加Swagger UI的蓝图，参考https://github.com/sveint/flask-swagger-ui

python代码

from flask import Flask, jsonify
from flask_swagger import swagger
from flask_swagger_ui import get_swaggerui_blueprint

app = Flask('Test')

# 1. 通过swagger_from_file关键词搜索对应的文档
@app.route('/fun_json')
def spec():   
   return jsonify(swagger(app, from_file_keyword="swagger_from_file"))

# Call factory function to create our blueprint
swaggerui_blueprint = get_swaggerui_blueprint(
    base_url='/api/docs',  # URL for exposing Swagger UI (without trailing '/')
    api_url='http://127.0.0.1:5003/fun_json',  # Our API url (can of course be a local resource)
    config={  # Swagger UI config overrides
        'app_name': "测试应用",
        'title': "测试应用"
    },
)

# 2. swagger_from_file指定对应的配置文件，其中yaml文件的配置
@app.route('/def_fun', methods=["POST"])
def login():
   """
   swagger_from_file: test.yaml
   """
   return 'login success'

app.register_blueprint(swaggerui_blueprint)

if __name__ == '__main__':
   app.run(host='127.0.0.1', port='5003', debug=False, use_reloader=False)
   # 浏览器打开http://127.0.0.1:5003/api/docs/

yaml文件

Create a new user
---
tags:
  - users
definitions:
  - schema:
      id: Group
      properties:
        name:
          type: string
          description: the group's name
parameters:
  - in: body
    name: body
    schema:
      id: User
      required:
        - email
        - name
      properties:
        email:
          type: string
          description: email for user
        name:
          type: string
          description: name for user
        address:
          description: address for user
          schema:
            id: Address
            properties:
              street:
                type: string
              state:
                type: string
              country:
                type: string
              postalcode:
                type: string
        groups:
          type: array
          description: list of groups
          items:
            $ref: "#/definitions/Group"
responses:
  201:
    description: User created

页面显示