用户指南
这个用户指南将指导你怎样去使用fastapi,
运行代码
所有的代码都能够直接复制并运行,为了运行这些实例,直接拷贝代码到main.py文件中,然后使用uvicorn运行:
uvicorn main:app -reload
安装fastapi
安装fastapi第一步
你也许想要安装它的所有依赖项目:
pip install fastapi[all]
它也会安装uvicorn,
注意:
你也可以分开安装:
pip install fastapi
pip install uvicorn
第一步:
最简单的fastapi例子如下:
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {“message”: “Hello World”}
拷贝到main.py文件,然后启动服务:
uvicorn main:app --reload
注意:
这个命令中的main:是main.py文件。
app是创建的fastapi实例,使用app=FastAPI()所创建的。
–reload,是为了让服务器实现热加载。
uvicorn默认使用的是8000端口,如果想更换端口可使用–port
服务器启动以后,就可以访问http://127.0.0.1:8000/docs去看api文档。(swagger ui提供)
openapi
fastapi在所有使用openapi标准定义的api中继承了一个“schema”。
“schema”
这个“schema”是一个事物的定义或者描述。仅仅是一个抽象的描述。
API“schema”
在这种情况下,OpenAPI是规定如何定义API模式的规范。
此OpenAPI架构将包括您的API路径,它们采用的可能参数等。
Data"schema"
这个模式也可用于定义数据,就像json内容。
它将意味着json的属性,以及它所拥有的数据类型。
查看openapi.json
如果你对于openapi模式感兴趣,它其实就是自动生成的json文件用于描述你的api
你可以通过:http://127.0.0.1:8000/openapi.json去看。
openapi到底能做什么
这个openapi模式驱动内部的两个系统文档。
并且有许多基于openapi的,你可以很容易的将他们加入你的fastapi程序中。
你也可以用它自动生成代码,为了让客户端来和你的api进行联系。
step by step
1、导入fastapi
from fastapi import FastAPI
2、创建api实例
app=FastAPI()
3、创建路径
操作基于http的方法,
POST:创建数据
GET:读取数据
PUT:更新数据
DELETE:删除数据
OPTIONS
HEAD
PATCH
TRACE
@app.get(’/’)
4、定义路径操作函数
path:是/
operation:是get
function:是在装饰器下面定义的函数。
async def root():
…
也可使用普通的def 定义的函数