基于FastApi框架测试平台(1)-搭建FastApi服务

757 阅读1分钟

安装FastApi

如下命令会安装所有依赖项,包括了 uvicorn,你可以将其用作运行代码的服务器。 pip install "fastapi[all]" 也支持分开安装 pip install fastapi 并且安装uvicorn来作为服务器 pip install "uvicorn[standard]"

编写FastApi服务文件

基本步骤:

  1. 导入FastAPI
  2. 创建一个FastAPI实例
  3. 创建一个路径操作
  4. 定义路径操作函数
  5. 返回内容

test-craft/main.py

from fastapi import FastAPI
​
app = FastAPI()
​
​
@app.get("/")
async def root():
    return {"message": "Hello World"}

运行开发服务器

uvicorn main:app --reload

uvicorn main:app 命令含义如下:

  • mainmain.py 文件。
  • app:在 main.py 文件中通过 app = FastAPI() 创建的对象。
  • --reload:让服务器在更新代码后重新启动。仅在开发时使用该选项。

启动成功,输出日志:

INFO:     Will watch for changes in these directories: ['/Users/hhb/PycharmProjects/test-craft']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [80504] using WatchFiles
INFO:     Started server process [80508]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

访问http://127.0.0.1:8000,可以看到JSON 响应如下

{"message": "Hello World"}

交互式API文档

访问http://127.0.0.1:8000/docs,会看到自动生成的交互式API文档(基于Swagger UI)

踩坑

如果访问空白,可以尝试升级fastapi版本,执行命令pip install --upgrade fastapi,升级成功后,重新启动服务。

访问http://127.0.0.1:8000/redoc,会看到基于ReDoc生成的API文档

到这里,启动一个简单的FastApi服务器就完成了,很简单吧,相信你也可以成功。