大家好,我是Kuls。
这篇文章主要是跟大家详细剖析一个简单的FastAPI程序。
这个程序就是我们上篇文章中所写的:
from fastapi import FastAPI app = FastAPI() @app.get("/items/{item_id}") def read_item(item_id: int, keyword: str): return {"item_id": item_id, "keyword": keyword}
本文的目的就是通过这个程序来学习FastAPI中相关的知识点,下面我们一行一行来进行剖析。
from fastapi import FastAPI
其实这行代码大部分学过Python的读者都知道,但是因为有一些是没有Python基础的读者也在学习,所以这里我也简单说下。
这行代码的意思就是从 fastapi 库中导入一个叫做FastAPI的类,我们整个FastAPI程序都是基于这个类来实现的。
app = FastAPI()
这行也比较好理解,就是将FastAPI类进行实例化,并且将值赋给app。这里的app当然不是固定的,我们也可以命名为myapp,如果我们是这样写的:
myapp = FastAPI()
那么我们在运行的时候就得输入这样的命令行:
如果app没修过 $ uvicorn main:app --reload --port 8000 如果app修改成myapp $ uvicorn main:myapp --reload --port 8000
其实前面的main代表的就是我们的文件名,如果我们再将main.py修改成demo.py,那么我们将会这样执行
$ uvicorn demo:myapp --reload --port 8000
如果我们还是按照之前的命令行运行就会报如下错误
所以uvicon也是非常灵活的,都是可配置化的。
@app.get("/items/{item_id}")
熟悉Python的朋友应该知道@代表的是装饰器的意思,如果你不懂装饰器,可以先去谷歌一下,其实你也可以理解它就是一个函数。
在这里我们引用app中的get方法,其含义就是发起一个 GET 请求,这里我们也可以换成post、put、delete....
具体我们可以看相应的源码,对应的其实就是那几个很常见的网络请求操作。
在get函数内的参数,我们称之为路径参数,就是我们访问的 http://127.0.0.1:8000/items/1?keyword=book
其中{item_id},代表的就是上面的 1 ,它会将 item_id 的值将作为参数 item_id 传递给我们下面所写的函数。
def read_item(item_id: int, keyword: str):
这个函数就是路径操作函数,我们来一步步拆解它。
首先def 函数名 这个大家没什么争议,主要是后面这一部分。
item_id: int ,大家可能会发现这个与我们上面所讲的 @app.get("/items/{item_id}") 中定义的 {item_id} 是一样的名字,我们的路径操作函数就是通过这样来传输用户所输入的路径的。
其中int 就是定义这个传入的数据类型,这里给大家演示一下。
如果此时我们传输进去一个字符串,那会发生什么?
我们可以看到fastapi给我反馈出了错误的原因以及位置
"loc": [ "path", "item_id" ],
loc就代表着我们在path路径中的item_id出现了错误,那么具体是什么错呢?
"msg": "value is not a valid integer", "type": "type_error.integer"
我们传入的值不是一个int,所以在这里也可以看出fastapi的错误机制其实非常不错的,能够给我们一个比较清晰直观的错误提示。
聊完了前面那个参数,那我们来聊聊后面这个 keyword: str
,这一部分跟前一个参数不同,前一个参数在我们的路径参数中有所体现,但是这个只出现在了函数的参数中。
FastAPI 其实非常聪明,能够分辨出参数 item_id 是路径参数而 keyword 不是,因此它会判断 keyword 是一个查询参数。
return {"item_id": item_id, "keyword": keyword}
我们最后来看看这行代码,这行代码其实就是返回一个json字符串。
我们在以后的项目当中,这一部分就是我们api返回的结果。
好了,到这里相信大家能够对这段代码有所理解了,这里K哥给大家留下一个作业。
如果我们想要制作一个博客,我们对于博客的首页、某一个博客内容页面、关于我的页面、搜索功能... 该如何设置路径参数呢?该返回哪些内容呢?
作业非常简单,大家可以尝试写一写!
非常高兴你能够看到这里,其实写系列文章没有写其他文章流量那么大,但是K哥仍然还是想系统的来给大家讲讲某门技术,之前也写过Django和Flask系列文章。所以这里也希望各位看完的朋友能够帮忙转发转发!
小白学FastAPI系列文章汇总: