FastAPI简单操作

FastAPI
首先讲一下基础操作，然后在介绍这些操作的意义

1. 创建

假设你创建了一个main.py的函数，并保存

from fastapi import FastAPI
app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

uvicorn main:app --reload

然后你可以在cmd中使用启动这个程序, 然后会显示一下信息：

localhost@asdil:/tmp/study$ uvicorn mian:app --reload
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [2414126] using statreload
INFO:     Started server process [2414128]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

接下来你在浏览器中打开http://127.0.0.1:8000就会显示一个最基础的get页面

基础get页面

如果不是在本地，而是使用远程服务器，那么你的启动命令变成:

uvicorn main:app --host '远程机器ip' --port 端口 --reload
比如:
uvicorn main:app --host '192.168.30.17' --port 8000 --reload

uvicorn参数解释:
main: 指定主程序文件main.py文件, 如果main.py文件改成test.py 则命令也需要改为uvicorn test:app
app：在main.py中使用app = FastAPI()创建的对象
--host：远程主机ip，如果是本地则可以不要这个参数
--host：端口号
--reload：在修改源代码后程序会自动重新加载不用退出重新启动

注意：

在使用 uvicorn main:app --reload启动后，如果想shutdown请使用ctrl+c, 而不是ctrl+z，后者其实是退出前台，如果ctrl+z后你想在启动会报端口被占用

2. get

这个是最常见的请求形式
(1) url参数
修改main.py

from fastapi import FastAPI
app = FastAPI()
# url参数定义在这个修饰器里面
@app.get("/{url}")
def read_root():
    return {"Hello": "World"}

我们在@app.get中定义了url参数，那么我们下次get请求时就不能直接输入http://127.0.0.1:8000而是http://127.0.0.1:8000/xxxx(xxxx表示任意字符串)

(2) param参数
修改main.py

from fastapi import FastAPI
app = FastAPI()
# url参数可以和param重合
@app.get("/{url}")
def read_root(url: str, parms_1: str, parms_2: str=None):
    return {'url地址是: ': url, "parms_1参数是 ": parms_1, "parms_2参数是 ": parms_2}

这是输入http://192.168.30.17:8000/anywords?parms_1=abc&parms_2=def就可以了，这里我使用的是远程服务器，因此我指定了ip和端口

parm参数

说明:
1.如果有parm参数则在地址后面加 ?,多个parm参数使用 & 连接
2.return中单引号和双引号没有区别
3.从上面可以看出url参数可以和parm参数合一，这是第一个url参数就不需要?url=，而是直接跟在端口80000/后面

3. post

post方法参数不是直接接在url后面，安全性会好一些
使用post时需要继承BaseModel这个类
(1)body参数

from fastapi import FastAPI
from pydantic import BaseModel    #fastapi的一个依赖,需要从pydantic中引入
app = FastAPI()
class Args(BaseModel):    #继承BaseModel
    data_str: str    #定义一个字符串型参数
    data_int: int    #定义一个整形参数
    data_list: list  #定义一个列表
        
@app.post("/test_post")
async def postEchoApi(args:Args):    #设置刚才定义的参数
    dict_args = args.dict() # 也可以转化为字典
    return {"str data":args.data_str, 
            'int data': args.data_int, 
            'list data':args.data_list, 
            'args 数据类型': str(type(args))}

postman

测试post的时候就用postman就可以了，注意是在Body选择Raw在选择Json形式传入参数

3. 在服务器部署fastapi

第一种使用方式

uvicorn main:app --host '0.0.0.0' --port 8000 --reload --workers 1

第二种使用方式(推荐)
Gunicorn是一个成熟的、功能齐全的服务器和流程管理器。
Uvicorn包含一个Gunicorn worker类，允许您运行ASGI应用程序，具有Uvicorn的所有性能优势，同时还为您提供了Gunicorn的全功能流程管理。
这允许您动态地增加或减少工作进程的数量，正常地重新启动工作进程，或者在不停机的情况下执行服务器升级。
对于生产部署，我们建议将gunicorn与uvicorn worker类一起使用。

gunicorn main:app -b 0.0.0.0:8000 -w 1 -k uvicorn.workers.UvicornWorker

===============================下次再写===========================

最后编辑于：2020.10.15 17:17:43