Flask-Swagger-UI 项目教程

最新推荐文章于 2025-04-19 07:09:01 发布

原创最新推荐文章于 2025-04-19 07:09:01 发布 · 313 阅读

3 ·

CC 4.0 BY-SA版权

Flask-Swagger-UI 项目教程

flask-swagger-ui Swagger UI blueprint for flask 项目地址: https://gitcode.com/gh_mirrors/fl/flask-swagger-ui

1. 项目的目录结构及介绍

flask-swagger-ui/
├── flask_swagger_ui/
│   ├── __init__.py
│   ├── static/
│   │   ├── css/
│   │   ├── fonts/
│   │   ├── images/
│   │   ├── lang/
│   │   └── swagger-ui.js
│   └── templates/
│       └── swagger-ui.html
├── setup.py
├── README.md
└── requirements.txt

flask_swagger_ui/: 项目的主要代码目录。
- __init__.py: 初始化文件，定义了 Flask 扩展的入口。
- static/: 存放静态文件，如 CSS、字体、图片和 JavaScript 文件。
- templates/: 存放 HTML 模板文件，swagger-ui.html 是 Swagger UI 的主模板。
setup.py: 项目的安装配置文件，用于打包和分发项目。
README.md: 项目的说明文档，通常包含项目的简介、安装和使用说明。
requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

在 Flask-Swagger-UI 项目中，没有明确的“启动文件”，因为这是一个 Flask 扩展，通常需要集成到你的 Flask 应用中。你可以通过以下方式在你的 Flask 应用中使用 Flask-Swagger-UI：

from flask import Flask
from flask_swagger_ui import get_swaggerui_blueprint

app = Flask(__name__)

SWAGGER_URL = '/api/docs'  # URL for exposing Swagger UI (without trailing '/')
API_URL = 'http://petstore.swagger.io/v2/swagger.json'  # Our API url (can of course be a local resource)

# Call factory function to create our blueprint
swaggerui_blueprint = get_swaggerui_blueprint(
    SWAGGER_URL,  # Swagger UI static files will be mapped to '{SWAGGER_URL}/dist/'
    API_URL,
    config={  # Swagger UI config overrides
        'app_name': "Test application"
    },
    # oauth_config={  # OAuth config. See https://github.com/swagger-api/swagger-ui#oauth2-configuration .
    #    'clientId': "your-client-id",
    #    'clientSecret': "your-client-secret-if-required",
    #    'realm': "your-realms",
    #    'appName': "your-app-name",
    #    'scopeSeparator': " ",
    #    'additionalQueryStringParams': {'test': "hello"}
    # }
)

app.register_blueprint(swaggerui_blueprint, url_prefix=SWAGGER_URL)

if __name__ == "__main__":
    app.run()

在这个示例中，get_swaggerui_blueprint 函数用于创建一个 Swagger UI 的蓝图，并将其注册到 Flask 应用中。