以下是一个简单的例子，演示如何使用元数据和自定义文档 URL：
from fastapi import FastAPI
app = FastAPI(
title="My FastAPI App",
description="This is a sample FastAPI application.",
version="1.0.0",
redoc_url="/docs",
swagger_ui_oauth2_redirect_url="/docs/oauth2-redirect",
)
@app.get("/")
async def read_root():
return {"message": "Hello, World!"}
在这个例子中：
- title 参数用于设置文档的标题。
- description 参数用于设置文档的描述。
- version 参数用于设置文档的版本号。
- redoc_url 参数用于指定 Redoc 的 URL。在这里，我们将 Redoc 的文档页设置为 /docs。
- swagger_ui_oauth2_redirect_url 参数用于指定 Swagger UI 的 OAuth2 重定向 URL。在这里，我们将其设置为 /docs/oauth2-redirect。
在应用程序启动后，你可以访问文档页面，例如 http://localhost:8000/docs（或你的自定义 URL）。这里，我们使用了 Redoc 的文档页，但你也可以使用 Swagger UI，具体取决于你的偏好。
在实际应用中，你可能还需要配置其他元数据，如联系信息、许可证等。这些元数据将被包含在生成的 OpenAPI 文档中。
总之，通过使用 FastAPI 的应用程序构造函数参数，你可以轻松配置生成的文档的各个方面，以满足你的需求。
转载请注明出处：http://www.pingtaimeng.com/article/detail/7399/FastAPI