FastAPI 2:路径操作配置

路径配置的一些参数,通过路径操作装饰器去配置它,包括:

• 1. status_code

• 2. tags

• 3. summary & description

• 4. response_description

• 5. deprecated

1、status_code

使用status_code参数来声明HTTP状态码,可以通过状态码数字、状态码变量方式来使用。

常用的有:

• 200及以上    成功的响应
• 300及以上    重定向
• 400及以上    客户端错误
• 500及以上    服务端错误

from fastapi import FastAPI

app =FastAPI()

@app.post("/status_code/", status_code=200)
def status_code():
    return {"status_code": 200}

如果不记得具体的数字,可以使用FastAPI提供的变量形式。

这与上面的数字效果是一样的,两种方式都可以。

from fastapi import FastAPI, status

app = FastAPI()

@app.post("/status_attribute/", status_code=status.HTTP_200_OK)
def status_code():
    return {"status_code": status.HTTP_200_OK}

表现形式:

2、tags

标签的作用可以将不同的API进行分类:

from fastapi import FastAPI

app = FastAPI()

@app.post("/create/item", tags=["items"])
def create_item():
    return {"info":"create item"}

@app.get("/get/item", tags=["items"])
def read_items():
    return {"info":"get items"}

@app.get("/users", tags=["users"])
def read_users():
    return {"info":"get users"}

表现形式:

3、summary & description

summary,是对这个api的简短说明,说明当前这个api是干什么用的。

description,是对这个api的说明,比如是实现的什么功能。

from fastapi import FastAPI

app = FastAPI()

@app.post("/create/item",
          tags=["items"],
          summary="create an item",
          description="this is a item,about ..."
)

表现形式:

但是如果说明内容很多,此时可以在函数中进行注释说明,FastAPI会自动在文档中显示。

@app.post("/docs/item",
          tags=["items"],
          summary="create an item")
def create_item():
    """    create an item with all infomation:
    - **name**: each item must have a name
    - **description**: a long description
    - **price**: required
    ...
    """

    return{"info":"create item"}

表现形式:

4、response_description

对响应的数据进行说明:

from fastapi import FastAPI

app = FastAPI()

@app.post("/create/item",
          tags=["items"],
          summary="create an item",
          description="this is a item,about ...",
          response_description="the created item ...")
def create_item():
    return {"info":"create item"}

表现形式:

5、deprecated

对废弃的API进行标识。

比如,API升级为V2.0版本,那么之前的V1.0版本废弃了,废弃了并不代表不能使用,所以可以通过 deprecated 标识配置值为True 进行区分。

from fastapi import FastAPI

app = FastAPI()

@app.post("/create/item",
          tags=["items"],
          summary="create an item",
          description="this is a item,about ...",
          response_description="the created item ...",
          deprecated=True)
def create_item():
    return {"info":"create item"}

表现形式:

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,402评论 6 499
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,377评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,483评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,165评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,176评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,146评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,032评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,896评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,311评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,536评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,696评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,413评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,008评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,815评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,698评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,592评论 2 353