首先需要安装依赖:
pip install flasgger
封装swagger.py文件,代码如下:
- from flasgger import Swagger
- swagger = Swagger()
然后在主应用中(项目入口文件)加入以下代码:
- from flask import Flask
- from swagger import Swagger #导入封装好的swagger.py文件中的Swagger对象
- # 创建 Flask 实例
- app = Flask(__name__)
- Swagger(app)
然后在user.py文件中加入以下代码:
- #举例
- @user_bp.route('/info', methods=['GET'])
- def user_info():
- """获取用户信息
- ---
- parameters:
- - name: Authorization
- in: header
- required: true
- description: 用户token
- type: string
- responses:
- 200:
- description: 成功
- schema:
- properties:
- code:
- type: integer
- msg:
- type: string
- data:
- type: object
- 401:
- description: 失败
- """
- userInfo = get_jwt_identity()
- if not userInfo:
- return r(msg='暂未登录')
- else:
- return r(msg='',data=userInfo)
运行项目,
访问:http://127.0.0.1:5000/apidocs/