运用 FastAPI 开发 python3 接口

柔光的暖阳◎ 2023-07-01 08:49 3阅读 0赞

FastAPI 文档 [https://fastapi.tiangolo.com/][https_fastapi.tiangolo.com]

FastApi 是一个异步 Web 框架，它的速度非常非常非常快。远远超过 Flask。速度可以匹敌 Golang 写的接口

有官方的docker 镜像，方便用docker部署

1、安装 FastAPI 模块

python3 -m pip install fastapi

2、安装 Uvicorn 模块（生产环境使用的ASGI服务器）

Uvicorn是基于[uvloop][]和[httptools][]构建的闪电般快速的ASGI服务器

python3 -m pip install uvicorn

3、创建 main.py 文件

#!encoding=utf8
      
    from fastapi import FastAPI
    
    app = FastAPI()
    
    
    @app.get("/")
    def read_root():
        return {"Hello": "World"}

4、启动ASGI Server

uvicorn main:app --reload

该命令uvicorn main:app指的是：
    
    main：文件main.py（Python“模块”）。
    app：main.py在线内创建的对象app = FastAPI()。
    --reload：更改代码后使服务器重新启动。这样做是为了开发

执行命令后会有如下输出

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
    INFO:     Started reloader process [13201]
    INFO:     email-validator not installed, email fields will be treated as str.
    To install, run: pip install email-validator
    INFO:     Started server process [13203]
    INFO:     Waiting for application startup.
    INFO:     Application startup complete.

说明了访问http的服务器地址和端口号，以及退出的方法

5、浏览器访问  [http://127.0.0.1:8000][http_127.0.0.1_8000]

会在浏览器显示

{"Hello":"World"}

说明接口访问成功

6、查看接口文档，有两种接口文档

[http://127.0.0.1:8000/docs][http_127.0.0.1_8000_docs]

[http://127.0.0.1:8000/redoc][http_127.0.0.1_8000_redoc]

以上都是官方的说明文档中的内容，详细使用方法还是直接访问 官方文档吧

[https_fastapi.tiangolo.com]: https://fastapi.tiangolo.com/
[uvloop]: https://github.com/MagicStack/uvloop
[httptools]: https://github.com/MagicStack/httptools
[http_127.0.0.1_8000]: http://127.0.0.1:8000
[http_127.0.0.1_8000_docs]: http://127.0.0.1:8000/docs
[http_127.0.0.1_8000_redoc]: http://127.0.0.1:8000/redoc