flasgger手写phpwind接口文档

最新推荐文章于 2024-11-23 14:15:17 发布

原创

最新推荐文章于 2024-11-23 14:15:17 发布 · 1k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#python #flask

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

前言

Flask是一个使用 Python 编写的轻量级 Web 应用框架。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

提示：以下是本篇文章正文内容，下面案例可供参考

一、flasgger是什么？

在flask框架中使用的swagger即为flasgger，flasgger是flask支持的swagger UI，便于调试使用flask框架搭建的web api接口

二、使用步骤

1.引入库

代码如下（示例）：

pip install flasgger

2.创建app

代码如下（示例）：

import json
from flask import Flask, request, Response
from flasgger import swag_from, Swagger


def create_app():
    app = Flask(__name__, instance_relative_config=True)
    app_config = {}
    app.config.from_mapping(app_config)
    app.config['SWAGGER'] = {
        'title': 'phpwind论坛',
        'openapi': '1.0.1'
    }
    Swagger(app, template={
        'title': 'Swagger Callbacks',
        'openapi': '3.0.3',
        "components": {
            "securitySchemes": {
                "BearerAuth": {
                    "in"