轻量级
web
后端框架,类似于flask
,额外可以自动生成文档
点击前往:官网地址
学习的目的是用于前后端分离开发,所以不学习模板部分的内容
一、环境搭建
pip install "fastapi[all]"
使用该操作会同时安装
fastApi
和uvicorn
(运行代码的服务器)
或者使用下述命令进行分开安装:
pip install fastapi
pip install "uvicorn[standard]"
二、第一个程序:hello fastApi
1、新建一个名为main.py
的python文件
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def root():
return {"message": "Hello fastApi"}
2、启动fastApi
服务
uvicorn main:app --reload
3、浏览器查看效果
uvicorn main:app
命令含义如下:
-
main
:main.py
文件(一个Python
「模块」)。 -
app
:在main.py
文件中通过app = FastAPI()
创建的对象(对象名叫啥命令中用啥)。 -
--reload
:让服务器在更新代码后重新启动。仅在开发时使用该选项。
4、查看文档
1)查看交互式Api
文档:
http://127.0.0.1:8000/docs
2)查看可选的Api
文档
http://127.0.0.1:8000/redoc
三、Hello Api
解析
@app.get("/")
"/"
: 请求的路径,url
+ 端口号 + 请求路径-
get
: 是请求的方法,浏览器直接访问都是get
方法,必须要有一个返回值。除此之外,常用的方法还有:
-
post
:前端给过来的请求,需要返回值, -
put
:前端给过来的请求,不需要返回值,一般用作推送更新 -
delete
:前端给过来的请求,不需要返回值,一般用作删除操作
-
return {"message": "Hello World"}
返回值:可以返回一个dict
、list
、 str
、int
等等