如何在FastAPI中实现API文档自动生成并展示其用户界面？

本文共计905个文字，预计阅读时间需要4分钟。

如何在FastAPI中实现API文档自动生成和UI展示？

有了FastAPI这样的强大Python框架，我们可以方便地构建高性能的Web API。然而，在构建API的同时，我们还需要一个清晰、易于理解的API文档来辅助开发者。

FastAPI自带了API文档的自动生成和UI展示功能。以下是实现这一功能的步骤：

1. 安装FastAPI和Uvicorn（一个ASGI服务器）。

bashpip install fastapi uvicorn

2. 创建一个FastAPI应用，并使用`docs`参数来启用自动生成的文档。

pythonfrom fastapi import FastAPI

app=FastAPI(title=我的API, docs_url=/docs, redoc_url=/redoc)

3. 添加一些路由和视图函数。

python@app.get(/)async def read_root(): return {message: Hello World}

4. 启动应用。

bashuvicorn main:app --reload

现在，你可以通过访问`http://127.0.0.1:8000/docs`来查看自动生成的API文档，以及通过访问`http://127.0.0.1:8000/redoc`来查看Redoc风格的UI展示。

如何在FastAPI中实现API文档自动生成和UI展示

有了FastAPI这样强大的Python框架，我们可以方便地构建高性能的Web API。然而，在构建API的同时，我们也需要一个清晰和易于理解的API文档来帮助其他开发人员理解和使用我们的API。本文将介绍如何使用FastAPI自动生成API文档并通过UI展示出来。

首先，我们需要安装FastAPI和相关的依赖库。在命令行中运行以下命令来安装它们：

pip install fastapi pip install uvicorn pip install fastapi_utils登录后复制

接下来，我们需要导入必要的模块：

from fastapi import FastAPI from fastapi_utils.api_model import APIModel from fastapi_utils.api_doc import APIModelDoc登录后复制

然后，我们创建一个FastAPI的实例：

app = FastAPI()登录后复制

接下来，我们可以定义一个API模型。API模型是使用FastAPI提供的APIModel类来定义的，它可以包含用于API请求和响应的字段。

class User(APIModel): id: int name: str email: str登录后复制

在我们的FastAPI应用程序中，我们可以使用该模型来定义API路由和逻辑。

@app.get("/users/{user_id}", response_model=User, summary="Get user by ID", tags=["users"]) def get_user(user_id: int): return {"id": user_id, "name": "John Doe", "email": "johndoe@example.com"}登录后复制

在上面的代码中，我们为HTTP GET请求定义了一个路由/users/{user_id}，并指定了响应模型为User。我们还为该路由添加了一个简要说明和一个标签，以后我们可以通过标签来组织和过滤API文档。

接下来，我们可以使用APIModelDoc类来为我们的API模型生成文档。

docs = APIModelDoc(app) docs.register(User)登录后复制

有了以上代码，我们的API模型就被注册到了API文档中。

最后，我们需要使用docs.html方法来获取自动生成的API文档的HTML代码。

@api.route('/docs', method="GET", tags=["docs"]) def get_docs(): return docs.html()登录后复制

在上面的代码中，我们定义了一个GET路由/docs，并返回了自动生成的API文档的HTML代码。这里我们为这个路由添加了一个标签docs，以便在API文档中进行过滤和组织。

现在，让我们运行我们的FastAPI应用程序并查看自动生成的API文档。

if __name__ == "__main__": uvicorn.run(app, host="0.0.0.0", port=8000)登录后复制

在命令行中执行以下命令以启动应用程序：

python app.py登录后复制

然后在浏览器中访问localhost:8000/docs，您应该能够看到自动生成的API文档。

通过以上步骤，我们成功地在FastAPI中实现了API文档的自动生成和UI展示。您可以根据您的需求进一步定制和调整API文档的样式和内容。

希望本文能够帮助您使用FastAPI构建强大的API，并为您的API提供清晰和易于理解的文档。