解决基于FastAPI Swagger UI的文档打不开的问题

发布于:2025-02-10 ⋅ 阅读:(38) ⋅ 点赞:(0)

基于FastAPI Swagger UI的文档链接/docs/redoc在没有外网的状态下无法打开,原因是Swagger依赖的JS和CSS来自CDN。

https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js
https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css
https://fastapi.tiangolo.com/img/favicon.png
https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js

FastAPI可以配置这些链接地址,改为本地目录下,自定义Javascript和CSS的CDN地址
在这里插入图片描述

from fastapi import FastAPI
from fastapi.openapi.docs import (
    get_redoc_html,
    get_swagger_ui_html,
    get_swagger_ui_oauth2_redirect_html,
)

app = FastAPI(docs_url=None, redoc_url=None)

app.mount("/static", StaticFiles(directory="static"), name="static")

@app.get("/docs", include_in_schema=False)
async def custom_swagger_ui_html():
    return get_swagger_ui_html(
        openapi_url=app.openapi_url,
        title=app.title + " - Swagger UI",
        oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,
        swagger_js_url="/static/swagger-ui/swagger-ui-bundle.js",
        swagger_css_url="/static/swagger-ui/swagger-ui.css",
        swagger_favicon_url="/static/swagger-ui/favicon.png",
    )


@app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False)
async def swagger_ui_redirect():
    return get_swagger_ui_oauth2_redirect_html()


@app.get("/redoc", include_in_schema=False)
async def redoc_html():
    return get_redoc_html(
        openapi_url=app.openapi_url,
        title=app.title + " - ReDoc",
        redoc_js_url="/static/redoc/redoc.standalone.js",
        redoc_favicon_url="/static/redoc/favicon.png",
        with_google_fonts=False
    )

文件下载地址:
https://download.csdn.net/download/lilongsy/90355890

相关链接

https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/


网站公告

今日签到

点亮在社区的每一天
去签到