如何使用fastapi进行自定义doc文档

本文介绍: 参考官方文档地址：https://fastapi.ti a n g ol o.com/zh/how–t o/custom–docs–ui–assets/#self–host in g–javascript–and–css-fo r–docs。

参考官方文档地址：https://fastapi.ti ango lo.com/zh/how–t o/custom–docs–ui–asset s/#self–host ing-javascript–and–css-fo r–docs

版本 介绍

python==3.9
fastapi==0.104.1

原项目 目录：

.
├── app
│   ├── __init__.py
│   ├── main.py

改变后的项目 目录

.
├── app
│   ├── __init__.py
│   ├── main.py
└── static
	├── redoc.standalone.js
	├── swagger-ui-bundle.js
	└── swagger-ui.css

三个文件的下载 地址分别为：

http s://cdn.jsd e li vr.net/npm/sw agg e r-ui–dist@5.9.0/sw agg e r-ui–bundle.js
https://cdn.jsd e li vr.net/npm/sw agg e r-ui–dist@5.9.0/sw agg e r-ui.css
https://cdn.jsd e li vr.net/npm/re doc@next/bu ndles/re doc.standalone.js
如无法下载，可参考项目 https://github.com/silk–java/fastapi–tutor ial

在项目的启动文件中，添加 如下 代码


# ========设置docs文档为本地文件=========
from fastapi.staticfiles import StaticFiles
from fastapi.openapi.docs import (
    get_redoc_html,
    get_swagger_ui_html,
    get_swagger_ui_oauth2_redirect_html,
)
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-bundle.js",
        swagger_css_url="/static/swagger-ui.css",
    )

@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.standalone.js",
    )
# ========设置docs文档为本地文件=========