当前位置: 首页> 科技> 能源 > 郑州全网营销推广_广州十二区分布图_电商培训大概多少学费_网站优化关键词排名公司

郑州全网营销推广_广州十二区分布图_电商培训大概多少学费_网站优化关键词排名公司

时间:2025/7/11 11:07:42来源:https://blog.csdn.net/gs80140/article/details/145469618 浏览次数:0次
郑州全网营销推广_广州十二区分布图_电商培训大概多少学费_网站优化关键词排名公司

要自定义 FastAPI 中的 Swagger UI,且使用本地资源来代替 CDN。只是需要稍微修改一下。

修改后的代码:

步骤:

  1. 挂载本地静态文件目录:我们将本地的 Swagger UI 资源文件(如 .js, .css, favicon.png 等)放置在项目的一个目录中(例如:static/swagger-ui)。
  2. 自定义 Swagger UI 页面:您可以通过 FastAPI 的 get_swagger_ui_html() 方法来加载本地的 Swagger UI 页面。

修改后的代码:

from fastapi import FastAPI
from fastapi.responses import HTMLResponse
from fastapi.staticfiles import StaticFiles
from fastapi.openapi.docs import get_swagger_ui_htmlapp = FastAPI(docs_url=None,  # 禁用默认的 Swagger UI 地址redoc_url=None  # 禁用 ReDoc 默认地址
)# Step 1: Mount the static directory for Swagger UI resources
app.mount("/static", StaticFiles(directory="static"), name="static")# Step 2: Define custom Swagger UI route
@app.get("/docs", include_in_schema=False)
async def custom_swagger_ui():return get_swagger_ui_html(openapi_url="/openapi.json",  # 指定 OpenAPI 文档路径title="API Docs",  # 自定义页面标题swagger_js_url="/static/swagger-ui/swagger-ui-bundle.js",  # 本地 JS 文件swagger_css_url="/static/swagger-ui/swagger-ui.css",  # 本地 CSS 文件swagger_favicon_url="/static/swagger-ui/favicon.png"  # 本地 favicon 图标)

解释:

  1. 禁用默认的 Swagger UI

    docs_url=None,  # 禁用默认的 Swagger UI 地址
    redoc_url=None  # 禁用 ReDoc 默认地址
    

    通过设置 docs_url=Noneredoc_url=None,您禁用了 FastAPI 默认提供的 Swagger UI 和 ReDoc 文档路径。

  2. 挂载静态文件目录

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

    这行代码将本地 static 目录挂载为静态文件服务。Swagger UI 资源文件应该放在 static/swagger-ui 目录下。

  3. 自定义 Swagger UI 页面

    @app.get("/docs", include_in_schema=False)
    async def custom_swagger_ui():return get_swagger_ui_html(openapi_url="/openapi.json",title="API Docs",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")
    

    get_swagger_ui_html() 是 FastAPI 提供的函数,用于生成 Swagger UI 的 HTML 页面。您可以在其中自定义:

    • openapi_url:指定您的 OpenAPI 文档 URL。
    • swagger_js_urlswagger_css_urlswagger_favicon_url:指定 Swagger UI 需要的本地资源文件路径。

本地文件结构:

您的文件夹结构应该如下:

project/
│
├── app.py  # FastAPI 代码
├── static/
│   └── swagger-ui/
│       ├── swagger-ui.css
│       ├── swagger-ui-bundle.js
│       ├── swagger-ui-standalone-preset.js
│       └── favicon.png

访问 Swagger UI:

  • 启动应用后,访问 http://127.0.0.1:8000/docs,您应该可以看到加载了本地资源的 Swagger UI 页面,而不再依赖外部 CDN。

这样,您就可以使用 FastAPI 提供的本地资源来定制 Swagger UI 了。

关键字:郑州全网营销推广_广州十二区分布图_电商培训大概多少学费_网站优化关键词排名公司

版权声明:

本网仅为发布的内容提供存储空间,不对发表、转载的内容提供任何形式的保证。凡本网注明“来源:XXX网络”的作品,均转载自其它媒体,著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处。

我们尊重并感谢每一位作者,均已注明文章来源和作者。如因作品内容、版权或其它问题,请及时与我们联系,联系邮箱:809451989@qq.com,投稿邮箱:809451989@qq.com

责任编辑: