以下简介来自官网描述:
FastAPI是一个用于构建API的现代、快速(高性能)的web框架,使用Python3.6+并基于标准的Python类型提示。
关键特性:
pip install fastapi
fastapi不像django那样自带web服务器,所以还需要安装uvicorn或者hypercorn
pip install uvicorn
from fastapi import FastAPI app = FastAPI() @app.get("/") def read_root(): return {"Hello": "world"} @app.get("/item/{item_id}") def read_item(item_id: int, q: str = None): return {"item_id": item_id, "q": q}
uvicorn hello:app --reload
命令说明:
hello
: hello.py文件app
: 在hello.py文件中通过FastAPI()
创建的对象--reload
: 让服务器在更新代码后重新启动。仅在开发时使用该选项。打开浏览器访问:127.0.0.1:8000
,将显示:{"Hello":"world"}
浏览器访问:127.0.0.1:8000/item/1
,将显示:{"item_id":1,"q":null}
浏览器访问:127.0.0.1:8000/item/1?q=hello
,将显示:{"item_id":1,"q":"hello"}
浏览器访问:127.0.0.1:8000/docs
,将会看到由 Swagger UI自动生成的交互式API文档
或者访问:127.0.0.1:8000/redoc
,会看到由redoc自动生成的文档。
from typing import Optional from fastapi import FastAPI from pydantic import BaseModel app = FastAPI() class Item(BaseModel): name: str price: float is_offer: Optional[bool] = None @app.get("/") def read_root(): return {"Hello": "world"} @app.get("/item/{item_id}") def read_item(item_id: int, q: Optional[str] = None): return {"item_id": item_id, "q": q} @app.put("/items/{item_id}") def update_item(item_id: int, item: Item): return {"item_name": item.name, "item_id": item_id}
多了一个put请求,可以在文档页调试这个接口测试。