FastAPI 学习之路（十二）接口几个额外信息和额外数据类型

一，额外信息

 

我们有这样的一个需求，我们希望可以看到接口的一个简单的请求示例展示在我们的接口文档中，应该如何实现呢。我们看下如何实现的：

from fastapi import FastAPI
from typing import Optional
from pydantic import BaseModel


app = FastAPI()


class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
    tax: Optional[float] = None

    class Config:
        schema_extra = {
            # 这里就会展示在接口文档中
            "example": {
                "name": "lc",
                "description": "这是描述信息",
                "price": 300,
                "tax": 0.7
            }
        }


@app.post("/items")
def return_item(item: Item):
    result = {"item": item}
    return result

 我们请求下试试

接口满足我们的请求，我们看下接口文档是否有请求的示例。