前往小程序,Get更优阅读体验!
立即前往
发布
社区首页 >专栏 >FastAPI后台开发基础(14): 路径装饰器

FastAPI后台开发基础(14): 路径装饰器

原创
作者头像
bowenerchen
发布2024-11-15 09:14:00
发布2024-11-15 09:14:00
11300
代码可运行
举报
文章被收录于专栏:编码视界编码视界
运行总次数:0
代码可运行

指定status_code

代码语言:python
代码运行次数:0
复制
class Item(BaseModel):
    name: str
    description: str | None = None
    price: float
    tax: float | None = None
    tags: set[str] = ()


@app.post("/items/", response_model = Item, status_code = status.HTTP_201_CREATED)
async def create_item(item: Item):
    """
    注意:
        保证一致对齐,且使用空行进行分割,就可以自动换行

    场景:
        测试接口 默认 tag 为 default

    参数:
        此时没有指定 tags 参数
    """
    return item
status_code 为 201
status_code 为 201

指定tags

代码语言:python
代码运行次数:0
复制
@app.post('/items_2/', response_model = Item, tags = ['test_tag'])
async def create_item_2(item: Item):
    """
    示例:
    - 测试接口 用于测试 tags 参数
    - 测试指定了 tags 参数且只有一个值:test_tag
    """
    return item


@app.post('/items_3/', response_model = Item, tags = ['test_tag_1234', 'user_tag_interface'])
async def create_item_3(item: Item):
    """
    测试接口 用于测试 tags 参数

    此时指定了 tags 参数且有两个值

    中间空一行,这样就可以自动换行
    """
    return item
自定义路径tags
自定义路径tags

指定描述信息

代码语言:python
代码运行次数:0
复制
@app.post('/items_4/',
          response_model = Item,
          summary = '测试 summary 参数效果',
          response_description = '测试 response_description 参数效果',
          tags = ['测试 summary'])
async def create_item_4(item: Item):
    """
    测试接口 summary 和 response_description 参数效果
    """
    return item
指定描述信息
指定描述信息

废弃路径

代码语言:python
代码运行次数:0
复制
@app.post('/items_5/',
          response_model = Item,
          summary = '测试 deprecated',
          deprecated = True,
          tags = ['deprecated'])
async def create_item_5(item: Item):
    """
    测试接口 deprecated 参数效果
    """
    return item
废弃路径
废弃路径

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 指定status_code
  • 指定tags
  • 指定描述信息
  • 废弃路径
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档