Fastapi教程001

 
  • 老实说,本人英语水平有限,此文档翻译是在个人理解的基础上进行的,如有错误之处请指正,并且欢迎英语水平高的同学加入到这个行列中。而且大家能找到这个博客教程说明已经对Fastapi有了初步的了解,所以我就不在这里介绍这个框架了。


华丽的分割线


第一章

1.0 环境安装与简单Demo创建

  • 本文默认使用创建了一个Python3的虚拟环境进行学习的,如有疑问请移步 百度 进行环境创建

  • 第一步安装 Fastapi与uvicorn
  • pipenv install fastapi
  • pipenv install uvicorn
  • 两种方式任选一种即可
  • pip install uvicorn
  • pip install fastapi

2.0 第一个简单Fastapi代码实例

  • 首先新建一个 main.py文件,文件内容如下:
from fastapi import FastAPI # 导入 Fastapi

app = FastAPI() # 创建一个app实例

@app.get("/") # 注册路由 以`get`方法访问 可通过 http://127.0.0.1:8000/访问 
async def root(): 
    return {"message": "Hello World"} # 返回一个dict数据
  • 在终端中运行命令 uvicorn main:app --reload
INFO: Started reloader process [17961]
INFO: Started server process [17962]
INFO: Waiting for application startup.
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
  • 当命令运行完以后,终端中会出现上述输出,并且最后一行 http://127.0.0.1:8000 是服务启动后的地址,可复制输入到浏览器中进行访问,并且浏览器会显示以下结果:

{"message": "Hello World"}

  • Fastapi提供了一个交互式的文档,通过 http://127.0.0.1:8000/docs 可以查看,如图所示:

  • 该文档能够直接调试接口,并且request请求体格式、response返回值均有显示,能够帮助开发者进行开发,因此请务必看懂该文档的使用!!!

总结

  • 本节是个人根据官方文档摘取其主要内容所译,主要是给初学者一个基本的demo,通过简单demo对Fastapi的模型有个基础的认知。
  创建一个app的步骤总结如下:
  1. 导入 Fastapi `from fastapi import FastAPI`
  2. 创建一个app实例
  3. 创建路由装饰器 (@app.get("/"))  支持常见的 get、post、put、delete等方法
  4. 定义一个方法  def funcname(): ...
  5. 启动服务 命令: `uvicorn main:app --reload`