FastAPI(三)接口文档-配置路径

原创于 2023-02-13 14:10:31 发布 · 9k 阅读

CC 4.0 BY-SA版权

文章标签：

8 篇文章

订阅专栏

文章讲述了如何在使用FastAPI构建的项目中，通过设置/api前缀来调整接口文档的路径，并且讨论了在Nginx中进行反向代理的设置方法，以便在发布时通过特定关键字转发请求，同时提到了与SpringBoot的content-path的相似性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

默认的接口文档是:ip:port/docs，在我们发布项目的时候会进行Nginx的反向代理，需要设置关键字来转发。类似于SpringBoot中的content-path。方式如下：

为接口文档加上api前缀

app = FastAPI(
    openapi_url='/api/data_manger.json',
    docs_url="/api/docs",
    redoc_url="/api/redoc"
)