您可以在FastAPI应用程序中配置几件事。
标题,描述和版本
您可以设置:
- 标题:在OpenAPI和自动API文档用户界面中,用作API的标题/名称。
- Description:OpenAPI和自动API文档UI中对API的描述。
- 版本:API的版本,例如v2或2.5.0。
- 例如,如果您具有应用程序的先前版本(也使用OpenAPI),则很有用。
from fastapi import FastAPI
app = FastAPI(
title="My Super Project",
description="This is a very fancy project, with auto docs for the API and everything",
version="2.5.0",
)
@app.get("/items/")
async def read_items():
return [{"name": "Foo"}]
OpenAPI的URL
默认情况下,OpenAPI模式在提供/openapi.json。
但是您可以使用参数进行配置openapi_url。
例如,将其设置为/api/v1/openapi.json:
from fastapi import FastAPI
app = FastAPI(openapi_url="/api/v1/openapi.json")
@app.get("/items/")
async def read_items():
return [{"name": "Foo"}]
如果要完全禁用OpenAPI架构,可以设置openapi_url=None。
docs网址
您可以配置包括的两个文档用户界面:
- Swagger UI:在担任/docs。
- 您可以使用参数设置其URL docs_url。
- 您可以通过设置禁用它docs_url=None。
- ReDoc:在送达/redoc。
- 您可以使用参数设置其URL redoc_url。
- 您可以通过设置禁用它redoc_url=None。
例如,要将Swagger UI设置为在上使用/documentation并禁用ReDoc:
from fastapi import FastAPI
app = FastAPI(docs_url="/documentation", redoc_url=None)
@app.get("/items/")
async def read_items():
return [{"name": "Foo"}]