fastapi框架可以自动生成接口文档

安装FastAPI
pip install fastapi

test1.py

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):#路由处理函数中的q是查询参数,可以在请求URL中使用,例如/items/42?q=somequery
    return {"item_id": item_id, "q": q}
  #自动生成接口文档:http://127.0.0.1:8000/docs

vscode 终端里执行:uvicorn test1:app --reload 启动服务
访问:
http://127.0.0.1:8000/items/42?q=somequery
在这里插入图片描述
如果需要使用FastAPI的自动文档和交互式API页面功能,还需要安装uvicorn和[optional] python-multipart:
pip install uvicorn[standard]
pip install python-multipart

自动生成接口文档 http://127.0.0.1:8000/docs

在这里插入图片描述

这里刚开始 有个报错:raise PydanticImportError(f’{import_path} has been removed in V2.')
pydantic.errors.PydanticImportError: pydantic.error_wrappers:ErrorWrapper has been removed in V2.

解决方案:
只要把 pydantic版本降级1.10.2,
pip install pydantic==1.10.2

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
FastAPI是一个基于Python的现代、快速(高性能)的Web框架,它可以用于构建高性能的Web应用程序和API。下面是自动生成FastAPI项目记录文档的步骤: 1. 安装FastAPI和相关依赖:首先,你需要在你的Python环境中安装FastAPI和相关依赖。可以使用pip命令来安装,如下所示: ``` pip install fastapi uvicorn ``` 2. 创建FastAPI项目:使用你喜欢的IDE或命令行工具,在你选择的目录下创建一个新的项目文件夹。进入该文件夹,并创建一个Python虚拟环境(可选但推荐),然后初始化一个新的Python项目。 3. 创建主文件:在项目文件夹中创建一个名为`main.py`的文件,这将是你的FastAPI应用程序的入口文件。 4. 编写代码:在`main.py`文件中编写你的FastAPI应用程序代码。你可以定义路由、请求处理函数、模型等等。以下是一个简单的示例: ```python from fastapi import FastAPI app = FastAPI() @app.get("/") def read_root(): return {"Hello": "World"} ``` 5. 运行应用程序:使用命令行工具进入项目文件夹,并运行以下命令来启动FastAPI应用程序: ``` uvicorn main:app --reload ``` 这将启动一个开发服务器,并监听默认端口(8000)。你可以在浏览器中访问`http://localhost:8000`来查看应用程序的输出。 6. 自动生成文档FastAPI提供了自动生成API文档的功能。在浏览器中访问`http://localhost:8000/docs`,你将看到自动生成的交互式API文档。这个文档将显示你定义的路由、请求处理函数以及相关的请求和响应模型。 7. 记录文档FastAPI自动生成文档非常详细和易于理解,但如果你需要将其记录下来,你可以选择将其复制粘贴到一个文档文件中,或者使用Swagger UI提供的导出功能将其导出为HTML或PDF格式。 希望以上步骤对你有所帮助!如果你有任何进一步的问题,请随时提问。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值