FastAPI 使用nginx、FastAPI和Docker实现HTTPS

在本文中，我们将介绍如何使用nginx、FastAPI和Docker来实现HTTPS。

什么是FastAPI？

FastAPI是一个现代、快速（高性能）的Web框架，用于构建API（Application Programming Interface）。它是基于Python 3.7+标准化类型提示以及Python异步支持构建的。FastAPI相比于其他Python框架，具有更高的性能，同时还提供了自动化的API文档和客户端生成功能。

为什么要使用HTTPS？

HTTPS（Hypertext Transfer Protocol Secure）是一种用于安全交换数据的通信协议。它通过使用SSL/TLS加密技术来保护数据的传输，确保数据的机密性和完整性。使用HTTPS可以有效地防止敏感数据的泄露和篡改，提高数据传输的安全性。

配置nginx支持HTTPS

首先，我们需要配置nginx来支持HTTPS。下面是一个简单的nginx配置示例：

server {
    listen 443 ssl;

    ssl_certificate /path/to/certificate.crt;
    ssl_certificate_key /path/to/private.key;

    location / {
        proxy_pass http://fastapi:8000;
        proxy_set_header Host host;
        proxy_set_header X-Real-IPremote_addr;
        # ... 其他配置项
    }
}

在上面的示例中，我们监听443端口并启用SSL。ssl_certificate指定了SSL证书的路径，ssl_certificate_key指定了私钥的路径。

此外，通过配置proxy_pass将所有请求转发给FastAPI服务器。

配置FastAPI支持HTTPS

接下来，我们需要配置FastAPI来支持HTTPS。在FastAPI中，我们可以使用基于Starlette的安全中间件来实现。

首先，我们需要在FastAPI应用程序中安装安全中间件：

from fastapi import FastAPI
from starlette.middleware.httpsredirect import HTTPSRedirectMiddleware

app = FastAPI()

# 启用HTTPS重定向中间件
app.add_middleware(HTTPSRedirectMiddleware)

上述代码会启用HTTPS重定向中间件，任何HTTP请求都会被重定向到HTTPS。

接下来，我们需要生成SSL证书和私钥。可以使用工具如OpenSSL生成自签名证书：

openssl req -x509 -newkey rsa:4096 -nodes -out certificate.crt -keyout private.key -days 365

通过上述命令生成的certificate.crt和private.key文件即为SSL证书和私钥。

最后，我们需要在FastAPI应用程序中加载SSL证书和私钥：

import ssl

# 加载SSL证书和私钥
context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
context.load_cert_chain(certfile="/path/to/certificate.crt", keyfile="/path/to/private.key")

# 创建FastAPI应用程序
app = FastAPI()

# 将SSL上下文添加到服务器配置中
app.run(host="0.0.0.0", port=8000, ssl_context=context)

上述代码会创建一个FastAPI应用程序，并将加载的SSL证书和私钥设置为SSL上下文。最后，我们通过调用app.run来启动FastAPI服务器。

使用Docker部署FastAPI应用程序

最后，我们可以使用Docker来部署FastAPI应用程序和nginx。

首先，我们需要在项目根目录下创建一个Dockerfile：

# Dockerfile

# 基础镜像
FROM tiangolo/uvicorn-gunicorn-fastapi:python3.7

# 拷贝FastAPI应用程序到容器
COPY ./app /app

# 安装依赖
RUN pip install -r /app/requirements.txt

在上述Dockerfile中，我们使用了tiangolo/uvicorn-gunicorn-fastapi的基础镜像，该镜像集成了uvicorn和gunicorn。

接下来，我们可以使用Docker Compose来定义并运行多个容器：

# docker-compose.yml

version: '3'

services:
  fastapi:
    build:
      context: .
      dockerfile: Dockerfile
    volumes:
      - ./app:/app
    ports:
      - "8000:8000"
    depends_on:
      - nginx

  nginx:
    image: nginx:latest
    volumes:
      - ./nginx.conf:/etc/nginx/nginx.conf
      - ./certificate.crt:/path/to/certificate.crt
      - ./private.key:/path/to/private.key
    ports:
      - "443:443"

在上述docker-compose.yml文件中，我们定义了两个服务fastapi和nginx。通过build指令来构建fastapi服务，并通过volumes指令将本地的FastAPI应用程序挂载到容器中。

此外，我们还将nginx.conf、SSL证书和私钥挂载到nginx容器中。

最后，我们可以使用以下命令来启动容器：

docker-compose up

当容器启动后，FastAPI应用程序将通过nginx进行代理，同时支持HTTPS。

总结

通过使用nginx、FastAPI和Docker，我们可以轻松地实现FastAPI应用程序的HTTPS支持。首先，我们配置nginx来支持HTTPS；然后，在FastAPI中使用中间件来启用HTTPS重定向；最后，我们通过Docker来部署整个应用程序。使用HTTPS可以增加数据传输的安全性，保护敏感信息不被窃取或篡改。快速上手，享受FastAPI带来的高性能和便捷的API开发体验！