一.文档
文档地址：https://www.runoob.com/fastapi/fastapi-api-doc.html
https://fastapi.tiangolo.com/#standard-dependencies
http://127.0.0.1:8000/docs 来打开 Swagger UI 风格的文档 http://127.0.0.1:8000/redoc 来打开 ReDoc 风格的文档。
二、代码请求, 交互式api文档
from fastapi import FastAPI from typing import Union from pydantic import BaseModel app = FastAPI() class Item(BaseModel): name: str price: float is_offer: Union[bool, None] = None @app.get("/") def root(): return {"message": "Hello World"} # 函数接受两个参数： # item_id --是路径参数，指定为整数类型。 # q -- 是查询参数，指定为字符串类型或空（None）。 # 函数返回一个字典，包含传入的 item_id 和 q 参数。 # q 参数通过 Union[str, None] 表示可以是字符串类型或空，这样就允许在请求中不提供 q 参数。 # 使用浏览器访问 http://127.0.0.1:8000/items/5?q=runoob，你将会看到如下 JSON 响应： # {"item_id": 5, "q": "runoob"} @app.get("/items/{item_id}") def get_item(item_id: int, query: Union[str, None] = None): return {"item_id": item_id, "query": query} # http://127.0.0.1:8000/docs 来打开 Swagger UI 风格的文档 # http://127.0.0.1:8000/redoc 来打开 ReDoc 风格的文档。 @app.put("/items/{item_id}") def update_item(item_id: int, item: Item): return {"item_name": item.name, "item_id": item_id}
