使用FastAPI和Pydantic创建Swagger UI文档

本示例展示了如何使用FastAPI和Pydantic创建Swagger UI文档，可以方便地查看API的详细信息和测试接口。使用FastAPI的便捷性和Pydantic的数据验证功能，创建符合OpenAPI规范的文档及接口。

from fastapi import FastAPI
from fastapi.openapi.utils import get_openapi
from fastapi.responses import JSONResponse
from fastapi.encoders import jsonable_encoder
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    price: float
    is_offer: bool = None

@app.get("/items/{item_id}", response_model=Item)
async def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

@app.post("/items/")
async def create_item(item: Item):
    item_dict = item.dict()
    if item.is_offer:
        item_dict.update({"discount": "10%"})
    return JSONResponse(content=jsonable_encoder(item_dict))

def custom_openapi():
    if app.openapi_schema:
        return app.openapi_schema
    openapi_schema = get_openapi(
        title="Custom title",
        version="2.5.0",
        description="This is a very custom OpenAPI schema",
        routes=app.routes,
    )

    # Custom operation
    print("OpenAPI Schema:", openapi_schema)

    app.openapi_schema = openapi_schema
    return app.openapi_schema

app.openapi = custom_openapi

免责申明：文章和图片全部来源于公开网络，如有侵权，请通知删除 server@dude6.com