1. 安装:
pip install fastapi
并且安装uvicorn来作为服务器:
pip install uvicorn
最简单的 FastAPI 文件可能像下面这样:
# main.py
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
运行命令:
uvicorn main:app --reload
uvicorn main:app
命令含义如下:
-
main
:main.py
文件(一个 Python「模块」)。
- app:在
main.py
文件中通过app = FastAPI()
创建的对象。
-
--reload
:让服务器在更新代码后重新启动。仅在开发时使用该选项。
查看
打开浏览器访问 http://127.0.0.1:8000。
交互式 API 文档
跳转到 http://127.0.0.1:8000/docs。
你将会看到自动生成的交互式 API 文档(由 Swagger UI 提供):
可选的 API 文档
前往 http://127.0.0.1:8000/redoc。
你将会看到可选的自动生成文档 (由 ReDoc 提供):
查看
openapi.json
如果你对原始的 OpenAPI 模式长什么样子感到好奇,其实它只是一个自动生成的包含了所有 API 描述的 JSON。
你可以直接在:http://127.0.0.1:8000/openapi.json 看到它。
它将显示以如下内容开头的 JSON:
在命令行修改端口
uvicorn main:app --port 8080 --reload
也可以在py文件中 修改
from fastapi import FastAPI import uvicorn app = FastAPI( debug=True ) @app.get('/user/list') def user_list(): return {"user": "我是用户add_list"} if __name__ == '__main__': uvicorn.run("main:app", port=8080, reload=True)