掌握FastAPI:如何在API中处理查询参数、请求体与头部
背景简介
FastAPI是一个现代、快速(高性能)的Web框架,用于构建APIs,基于Python 3.6+的类型提示,能够自动生成交互式API文档。在开发API时,处理输入参数是至关重要的一个环节。本文基于FastAPI的官方文档,将带你深入理解如何在API中处理查询参数、请求体以及HTTP头部,并提供一些高级技巧和最佳实践。
查询参数
FastAPI通过装饰器中的路径操作将请求的URL参数自动映射到函数参数中。在本例中,我们定义了一个端点
/hi
,并通过查询参数
who
来接收传递的值。
@app.get("/hi")
def greet(who: str):
return f"Hello? {who}?"
通过浏览器或者使用HTTP客户端如HTTPie或Requests,我们可以向API传递查询参数。例如:
$ http localhost:8000/hi?who=Mom
返回结果将是:
"Hello? Mom?"
请求体
虽然GET请求通常用于获取数据,但有时我们也需要通过请求体发送数据。在FastAPI中,我们使用
Body
关键字来指定数据应该从请求体中获取。
from fastapi import FastAPI, Body
@app.post("/hi")
def greet(who: str = Body(embed=True)):
return f"Hello? {who}?"
使用
embed=True
参数,FastAPI会期待JSON格式的请求体,例如:
```json {"who": "Mom