推荐答案
在 FastAPI 中使用 ReDoc 非常简单，因为 FastAPI 默认集成了 ReDoc。你只需要在启动 FastAPI 应用后，访问 /redoc 路径即可查看自动生成的 API 文档。
以下是一个简单的示例：
// www.javascriptcn.com code example
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def read_root():
return {"Hello": "World"}
@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
return {"item_id": item_id, "q": q}启动应用后，访问 http://127.0.0.1:8000/redoc，你将看到自动生成的 ReDoc 文档。
本题详细解读
1. FastAPI 的自动文档生成
FastAPI 默认提供了两种自动生成的 API 文档：
- Swagger UI：可以通过
/docs路径访问。 - ReDoc：可以通过
/redoc路径访问。
ReDoc 是一个基于 OpenAPI 规范的 API 文档生成工具，它提供了更加简洁和易读的文档展示方式。
2. 如何自定义 ReDoc
虽然 FastAPI 默认集成了 ReDoc，但你也可以通过 FastAPI 的 docs_url 和 redoc_url 参数来自定义文档路径，或者禁用文档生成。
例如，如果你想禁用 ReDoc 文档，可以这样做：
from fastapi import FastAPI
app = FastAPI(docs_url=None, redoc_url=None)
@app.get("/")
def read_root():
return {"Hello": "World"}这样，/docs 和 /redoc 路径将不再可用。
3. ReDoc 的优势
- 简洁易读：ReDoc 的界面设计非常简洁，适合快速浏览和理解 API 的结构。
- 支持 OpenAPI 3.0：ReDoc 完全支持 OpenAPI 3.0 规范，能够展示复杂的 API 结构。
- 无需额外配置：FastAPI 默认集成了 ReDoc，开发者无需进行额外的配置即可使用。
4. 使用场景
ReDoc 适用于需要向团队或外部开发者展示 API 文档的场景。它的简洁性和易读性使得 API 文档更容易被理解和使用。
5. 总结
FastAPI 默认集成了 ReDoc，开发者可以通过简单的配置或直接访问 /redoc 路径来查看自动生成的 API 文档。ReDoc 提供了简洁易读的文档展示方式，非常适合快速浏览和理解 API 结构。