fastapi项目开发快速上手

简介

FastAPI 是一个用于构建 API 的现代、快速（高性能）的 web 框架，使用 Python 3.6+ 并基于标准的 Python 类型提示。

特性:

快速：可与 NodeJS 和 Go 比肩的极高性能（归功于 Starlette 和 Pydantic）。最快的 Python web框架之一。
高效编码：提高功能开发速度约 200％至 300％。
更少 bug：减少约 40％的人为（开发者）导致错误。斜体样式智能：极佳的编辑器支持。处处皆可自动补全，减少调试时间。
简单：设计的易于使用和学习，阅读文档的时间更短。简短：使代码重复最小化。通过不同的参数声明实现丰富功能。bug 更少。
健壮：生产可用级别的代码。还有自动生成的交互式文档。标准化：基于（并完全兼容）API 的相关开放标准：OpenAPI (以前被称为Swagger) 和 JSON Schema。

安装fastapi

pip install fastapi -i https://pypi.tuna.tsinghua.edu.cn/simple some-package

安装uvicorn

因为fastapi的运行依赖于uvicorn，所以我们再安装一下uvicorn
pip install uvicorn -i https://pypi.tuna.tsinghua.edu.cn/simple some-package

最简单的Demo先走一波

from fastapi import FastAPI
import uvicorn

app = FastAPI() # 创建 api 对象

@app.get("/") # 配置路由
def root():
    return {"成都": "雄起"}

# async def root():
#     return {"成都": "雄起"}


if __name__ == '__main__':
    uvicorn.run('main:app',port=8000) #main：py文件名 app：api对象名

在这里插入图片描述

简单解释一下，上面的Demo中有注释掉的async def root(),两种写法都可以用，只不过后者async是协程异步。后续会出文章单独讲协程实现并发I/O，这里顺带简单讲一下异步：比如程序在处理一个系统文件操作的时候windows系统需要5秒钟的时间才能给程序回复，那么在这5秒钟内程序就一直处于等待状态，如果5秒中内有新的命令进来，那么程序也不会执行。。那么异步的意思就是说，这5秒钟时间里程序不用处于等待的状态，可以执行其他命令，等到windows系统给回复后再回去继续执行剩下的。

再来一波get请求参数

from fastapi import FastAPI
import uvicorn
from pydantic import BaseModel

app = FastAPI() # 创建 api 对象

@app.get("/{item}") # 配置路由
def root(item:str)->str:  #注意：item:str这种写法的作用是提示，提示item这个参数是个str
                                # ->str 写法的作用也是提示，提示函数返回的是str
    if item=='ok':
        return {"成都": "雄起"}
        
if __name__ == '__main__':
    uvicorn.run('main:app',port=8000)

在这里插入图片描述

进阶Demo走一波

提要：在fastapi里，合理运用Python自带的第三方库pydantic中的BaseModel模块很重要，BaseModel模块用来检查接收的数据类型是否符合规范，如不符合，会报出具体错误。这也是fastapi受欢迎的原因之一，具体详见官方文档，这里不再赘述。
再来一波，进阶Demo：
这里需要安装下requests这个包哈。
pip install requests -i https://pypi.tuna.tsinghua.edu.cn/simple some-package

import requests
import json
import base64


item=json.dumps({'cmd':r'E:\cProject\arr.c'})
flag=requests.post('http://127.0.0.1:8000',item)

filestream=base64.b64decode(json.loads(flag.text))
with open('arr.c','wb') as f:
    f.write(filestream)

print('完成')

from fastapi import FastAPI
import uvicorn
from pydantic import BaseModel

app = FastAPI() # 创建 api 对象

class Item(BaseModel):
    cmd:str

@app.post('/')
def fileDowm(item:Item):  #把传过来的字典交给Item进行解析，若解析不正确返回422请求格式错误。
    '''
    文件下载模块
    :param item: {'cmd'：url}
    :return: filestream 字节流
    '''
    url=item.dict()['cmd']

    with open(url,'rb') as f:
        filestream=f.read()				#二进制读取文件
        import base64						
        filestream=base64.b64encode(filestream)    #转化为字节流进行文件传输
        
    return filestream


if __name__ == '__main__':
    uvicorn.run('main:app',port=8000)