局域网环境生成fastapi接口文档的方法

最新推荐文章于 2026-03-29 19:24:22 发布

原创最新推荐文章于 2026-03-29 19:24:22 发布 · 2.7k 阅读

5 ·

本内容遵循CC 4.0 BY-SA版权协议

本文档介绍如何在内部局域网环境中使用FastAPI自动生成Swagger UI接口文档，由于cdn访问限制，需要手动将所需文件置于static文件夹中，以确保在内网环境下正常显示。

fastapi自动生成的接口文档,基于Swagger UI, 但是在内部局域网环境无法访问cdn,因此无法自动生成docs接口文档.

如果要在内网环境生成docs接口文档,需要修改示例代码如下:

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

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


root = os.path.abspath(os.path.join(os.path.basename(__file__), "../.."))
print(root)

app.mount("/static", StaticFiles(directory=f"{root}/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",
    )


@app.get(
    "/users/{username}",
    tags=["test"],
    name="TESTROUTER",
    description="TESTROUTER",
)
async def read_user(username: str):
    return {"message": f"Hello {username}"}


if __name__ == '__main__':
    import uvicorn

    uvicorn.run(app, host="127.0.0.1", port=8000)