fastAPI有哪几种参数？
本文介绍了API开发中的参数类型及其校验方法。主要内容包括：1）参数定义及作用；2）三种参数类型（路径参数、查询参数、请求体参数）的使用方式；3）Path、Query、Field三种注解的功能与用法，分别用于校验路径参数、查询参数和请求体参数。文章通过具体示例演示了如何利用这些注解进行参数校验，并说明了校验规则和接口文档描述的应用。
·
目录
一.什么是参数？
1.参数的定义
参数就是客户端发送请求时附带的额外信息。
作用：让同一个接口，可以根据不同的输入，返回不同的输出。
二.参数的种类
1.路径参数
举例：
可见接口成功获取1，并打印对应结果。
解读三点：
- /{id}这是路径参数的写法
- id: int这是规定id是整数类型
- f"这是第{id}本书" 这里面的f表明可以拼接变量，类似vue中的飘号
2.查询参数
查询参数，就是前端get请求常用的传参方式。即：把参数拼在请求的url?后面，用&隔开
举例：
3.请求体参数
①导入BaseModel
②定义一个类
③写接口
④测试效果
三.Path类型注解（用于校验"路径参数"）
1.Path类型注解有什么用？
Path类型注解，主要用于校验路径参数。具体规则如下：
假如用户传参是整数，我们可以利用Path注解控制入参的范围，比如1~100
假如用户传参是字符串，我们可以利用Path注解控制入参的字符数，比如2~10个字符
2.用法
注意：下图的description里面的具体描述，会添加到接口文档中，从而帮助开发人员理解，其实和注释没区别，本质就是注释。
3.举例一
①第一步：导入Path
②第二步：写代码
③第三步：运行代码，测试效果
4.举例二
四.query注解（用于校验“查询参数”）
1.query注解有什么用？
校验查询参数
2.用法
和Path类型注解一致。
3.举例
①第一步：导入Query
②第二步：写代码
③第三步：运行代码，测试效果
五.Field类型注解（用于校验“请求体参数”）
1.Field类型注解有什么用？
用于校验“请求体参数”
2.用法
3.举例
以上就是本篇文章的全部内容，喜欢的话可以留个免费的关注呦~~~
腾讯云面向开发者汇聚海量精品云计算使用和开发经验，营造开放的云计算技术生态圈。
更多推荐
12
0- 0
已为社区贡献30条内容
所有评论(0)