每日一模块：Flasgger

葫芦侠五楼 • 2024年5月23日下午9:29 • 技术分享 • 阅读 394

Flasgger 是一个用于 Flask 的 Swagger UI 集成库，它允许你为你的 Flask API 自动生成 Swagger 文档。Swagger 是一个用于描述 RESTful API 的规范，它提供了用于生成、描述、调用和可视化 RESTful Web 服务的接口。

1. 安装 Flasgger

使用命令 pip 来安装：

pip install flasgger

2.在你的 Flask 应用中导入 Flasgger 并初始化

from flasgger import Swagger

app = Flask(__name__)
Swagger(app)

3. 为接口添加注释信息

在你的路由函数上方添加 Swagger 注释。如下面的示例，对于路径参数，你可以使用 parameters 列表，其中每个参数都是一个字典，包含以下键：

• name：参数名称
• in：参数位置，对于路径参数，这应该是 “path”
• description：参数描述
• required：布尔值，表示参数是否必需
• type：参数类型，例如 “string”、”integer” 等

@app.route('/hello/<name>', methods=['GET'])
def hello(name):
    """
    定义接口名称
    ---
    tags:
      - 对接口进行分组的自定义名称
    description: 接口是干什么的说明
    operationId: I00001
    parameters:
      - name: name
        in: path
        type: string
        description: 标语内容
        required: true
        example: BeiJin
    responses:
        200:
            description: 响应体
            schema:
                type: object
                properties:
                    message:
                        type: string
                        description: 字段说明
                example: {"message":"Hello,World!"}

    :param name: 口号标语
    :return:
    """
    return jsonify({'message': f'Hello, {name}!'}), 200