【FastAPI.S01E02】request请求相关：路径参数

原创

已于 2022-05-09 23:01:47 修改 · 867 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#python #postman #restful

于 2022-05-09 22:56:56 首次发布

本文详细介绍了FastAPI中的路径参数，包括基础用法、数值校验、预设值以及路径操作配置。通过实例展示了如何定义、验证和配置路径参数，如类型声明、使用Enum限制预设值、状态码、标签、摘要等。文章还提到，由于内容较多，仅涵盖了部分请求相关知识点，后续将根据实践继续补充。

文章目录

前言
一、路径参数基础
二、路径参数数值校验
三、路径参数预设值
四、路径参数路径操作配置
总结

前言

最近看了一遍FastAPI的官方文档中的请求部分，自己梳理了一下请求阶段的路径参数、查询参数、请求体、Cookie、Header的大致的使用方法，其中包含了数据校验以及元数据设置等。

以下例子均来自官方文档(本人比较懒，手动狗头）

本次就介绍下路径参数的具体使用方法：

一、路径参数基础

通过在装饰器中添加具体的路径，以及类似格式化字符串的方式来设置动态路径，具体代码如下：

import uvicorn
from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id:int):
    return {
   
   "item_id": item_id}

if __name__ == '__main__':
    uvicorn.run(app)

执行后的可在OpenAPI:http://127.0.0.1:8000/docs 界面查看到具体的接口信息
在这里插入图片描述
这里可以明确的说明这个参数是路径参数，item_id下面标注着path字样。

二、路径参数数值校验

数据校验方式一：使用python3.6以后加入的类型声明方式，那么当你传入具体参数的时候，框架会自动帮助你进行校验，具体从那做方式如下

import uvicorn
from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id:int):
    return {

最低0.47元/天解锁文章

200万优质内容无限畅学