之前一直用Flask,今年看到这个FastAPI框架,感觉还不错,体验了下,很容易就入门。
开始学习
官方描述
从官方的描述来看,有以下特点:
Python 3.6+
$ pip install fastapi
$ pip install uvicorn
# main.py
from fastapi import FastAPI
App = FastAPI()@app.get("/")
def read_root(): return {"Hello": "World"}
@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None): return {"item_id": item_id, "q": q}
如果是异步,可以这么写:
# main.py
from fastapi import FastAPI
app = FastAPI()@app.get("/")
async def read_root(): return {"Hello": "World"}
@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str = None): return {"item_id": item_id, "q": q}
$ uvicorn main:app --reload --port 18080
参数说明:
启动后输出:
INFO: Uvicorn running on http://127.0.0.1:18080 (Press CTRL+C to quit)
INFO: Started reloader process [19071]
INFO: Started server process [19091]
INFO: Waiting for application startup.
INFO: Application startup complete.
可以看到服务已经启动,访问路径是http://127.0.0.1:18080 。
打开你的浏览器,输入 http://127.0.0.1:18080 。
你将会看见JSON响应:
{"hello": "world"}
#myapi.py
import uvicorn
if __name__ == "__main__":
uvicorn.run("myapi:app", host="127.0.0.1", port=18080, log_level="info")
通过引入uvicorn库,那么我们就可以跟之前运行脚本的方式一样执行脚本就可以了。
python3 myapi.py
由于对外暴露文档,也是比较危险,那么我可不可以关闭API文档,答案是可以的,我们可以加一些参数来屏蔽它。
app = FastAPI(docs_url=None, openapi_url=None, redoc_url=None)
当你再次访问文档链接,会提示:
{"detail":"Not Found"}
是不是很简单,通过这个框架可以快速的完成接口。当然它还有更多的特性,这里就不展开了,有兴趣的可以自行查阅深入学习。