回顾
- 获取路径参数
- 什么是路径参数?
/user/{id}
- 什么时候使用?需要传递参数
- 怎么实现类型转换?声明参数的类型
- 怎么捕获文件路径?
{file_path:path}
什么是查询参数
查询字符串是键值对的集合,这些键值对位于 URL 的 ? 之后,以 & 分隔。
http://127.0.0.1:8000/items/?skip=0&limit=10
上面的 skip=0&limit=10
就是查询参数,表示:
- skip:0
- limit:10
怎么定义查询参数
示例代码:
from fastapi import FastAPI
app = FastAPI()
fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]
@app.get("/items/")
async def read_item(skip: int = 0, limit: int = 10):
return fake_items_db[skip : skip + limit]
这段代码中,没有路径参数,但是又有其他的方法参数:
@app.get("/items/")
async def read_item(skip: int = 0, limit: int = 10):
在方法参数中,除了路径参数之外,就是查询参数。
所以定义查询参数,实际上就是定义方法的参数。
案例:分页查询
当数据量非常大的时候,我们使用一个网页可能放不下那么多数据,所以就需要把数据分成一组一组的进行返回并渲染。这里的一组数据就是一页数据,每页数据到底有多少条这个叫每页的数量。分页一般用page表示,每页数量一般用size表示。
比如我们说访问第三页数据,实际上就是page=3的时候,返回的数据。
这里的page和size一般来讲就是查询参数,查询参数一般是放在GET方法中,用来作为查询数据的过滤条件的参数。
简单案例:
from fastapi import FastAPI
app = FastAPI()
# 查询用户
@app.get("/user")
async def get_user(page: int = 1, size: int = 20):
"""
查询用户信息
:param page: 第几页
:param size: 每页数量
:return: 分页用户信息
"""
return {
"page": page,
"size": size,
"count": 1000, # 数据库里面符合查询条件的数据个数
"data": [ # 当前页的具体信息
{"id": 1, "name": "张三", "age": 23},
{"id": 2, "name": "李四", "age": 33},
{"id": 3, "name": "王五", "age": 25},
]
}
if __name__ == '__main__':
import uvicorn
uvicorn.run(app, host='0.0.0.0', port=8888)
使用postman进行测试:
练习:返回所有用户
生成1000条用户信息,当我访问 http://127.0.0.1:8888/user?page=1&size=1000
把所有1000条用户信息,全部给我返回。每一条用户信息要包含ID,姓名,年龄三个字段。要求姓名不能重复,年龄不能全部相同,ID要唯一。
from fastapi import FastAPI
app = FastAPI()
# 查询用户
@app.get("/user")
async def get_user(page: int = 1, size: int = 20):
"""
查询用户信息
:param page: 第几页
:param size: 每页数量
:return: 分页用户信息
"""
data = []
for i in range(1, 1001):
data.append({"id": i, "name": f"张三{i}", "age": 20 + i % 10})
return {
"page": page,
"size": size,
"count": 1000, # 数据库里面符合查询条件的数据个数
"data": data
}
if __name__ == '__main__':
import uvicorn
uvicorn.run(app, host='0.0.0.0', port=8888)
代码优化
from fastapi import FastAPI
data = []
for i in range(1, 1001):
data.append({"id": i, "name": f"张三{i}", "age": 20 + i % 10})
app = FastAPI()
# 查询用户
@app.get("/user")
async def get_user(page: int = 1, size: int = 20):
"""
查询用户信息
:param page: 第几页
:param size: 每页数量
:return: 分页用户信息
"""
return {
"page": page,
"size": size,
"count": len(data), # 数据库里面符合查询条件的数据个数
"data": data
}
if __name__ == '__main__':
import uvicorn
uvicorn.run(app, host='0.0.0.0', port=8888)
练习:只需要返回前20条数据
现在是整个1000条数据都返回了,我现在只想要前20条,也就是第一页的数据。
@app.get("/user")
async def get_user(page: int = 1, size: int = 20):
"""
查询用户信息
:param page: 第几页
:param size: 每页数量
:return: 分页用户信息
"""
return {
"page": page,
"size": size,
"count": len(data), # 数据库里面符合查询条件的数据个数
"data": data[:size]
}
练习:想要第二页的20条数据
第一页:切片 [0:20]
第二页:切片 [20:40]
第三页:切片 [40:60]
用代码表示:page=2 size=20
- page:1 size:20 ===>> start:0 end:20
- page:2 size:20 ===>> start:20 end:40
- page:3 size:20 ===>> start:40 end:60
end = start + size
- start=0 size=20 end=0+20=20
- start=20 size=20 end=20+20=40
- start=40 size=20 end=40+20=60
start = (page - 1) x size
- page=1 size=20 start=(1-1) x 20=0x20=0
- page=2 size=20 start=(2-1)x20=1x20=20
- page=3 size=20 start=(3-1)x20=2x20=40
@app.get("/user")
async def get_user(page: int = 1, size: int = 20):
"""
查询用户信息
:param page: 第几页
:param size: 每页数量
:return: 分页用户信息
"""
start = (page - 1) * size
end = start + size
return {
"page": page,
"size": size,
"count": len(data), # 数据库里面符合查询条件的数据个数
"data": data[start:end]
}
使用postman测试:
遗留的问题
- 3、FastAPI
- 4、MySQL8
- 5、SQLModel,和FastAPI框架是同一个作者,两者结合比较好用,但是学习成本较高,使用难度稍大
- 6、Vue3
- 7、Tailwindcss
- 8、Ant Design Vue,UI组件库
- 9、数据同步:有一个API,这个API提供了一些数据,需要在ERP系统中进行展示。
- 10、登录注册需要吗?需要
- 11、第三方平台管理:对接哪些接口平台飞书,钉钉,聚水潭等等
- 12、用户管理
- 13、Docker
- 14、Linux
- 15、Nginx
- 16、项目部署实战