NGINX Unit

FastAPI§

要使用 Unit 运行使用 FastAPI Web 框架构建的应用

  1. 使用 Python 3.6+ 语言模块安装 Unit

  2. 创建一个虚拟环境来安装 FastAPI 的 PIP 软件包

    $ cd /path/to/app/
    $ python3 --version
          Python 3.Y.Z
    $ python3 -m venv venv
    $ source venv/bin/activate
    $ pip install fastapi
    $ deactivate
    

    警告

    使用与步骤 1 中的语言模块匹配的 Python 版本(本示例中为 3.Y)创建虚拟环境,直至次要版本号。此外,步骤 5 中的应用类型必须 解析 为类似的匹配版本;Unit 不会从环境中推断它。

  3. 我们尝试一下 教程应用 的版本,将其保存为 /path/to/app/asgi.py

    from fastapi import FastAPI
    
    app = FastAPI()
    
    @app.get("/")
    async def root():
        return {"message": "Hello, World!"}
    

    注意

    要获得更真实的体验,请尝试 RealWorld 示例应用;只需在安装 FastAPI 的同一虚拟环境中安装其所有依赖项,并将应用的环境 变量(如 DB_CONNECTIONSECRET_KEY)直接添加到 Unit 中的应用配置,而不是 .env 文件中。

  4. 运行以下命令,以便 Unit 可以访问 应用程序目录

    # chown -R unit:unit /path/to/app/
    

    注意

    unit:unit 用户组对仅适用于 官方包、Docker 镜像 以及一些 第三方仓库。否则,帐户名称可能有所不同;运行 ps aux | grep unitd 命令以确保。

    有关包括权限在内的更多详细信息,请参阅 安全清单

  5. 接下来,准备 Unit 的 FastAPI 配置(对 typehomepath 使用实际值)

    {
        "listeners": {
            "*:80": {
                "pass": "applications/fastapi"
            }
        },
    
        "applications": {
            "fastapi": {
                "type": "python 3.Y",
                "path": "/path/to/app/",
                "home": "/path/to/app/venv/",
                "module": "asgi",
                "callable": "app"
            }
        }
    }
    
  6. 上传更新后的配置。假设上面的 JSON 已添加到 config.json

    # curl -X PUT --data-binary @config.json --unix-socket \
           /path/to/control.unit.sock http://localhost/config/
    

    注意

    控制套接字 路径可能有所不同;运行 unitd -h 或参阅 启动和关闭 以了解详细信息。

    成功更新后,您的应用应可在侦听器的 IP 地址和端口上使用

    $ curl http://localhost
    
          Hello, World!
    

    或者,尝试 FastAPI 的简洁自文档功能

FastAPI on Unit - Swagger Screen