AWS Chalice 构建 REST API 实战教程

AWS Chalice 构建 REST API 实战教程

本文将详细介绍如何使用 AWS Chalice 框架构建一个功能完善的 REST API 服务。Chalice 是 AWS 推出的 Python 无服务器微框架，可以快速构建和部署基于 AWS Lambda 和 API Gateway 的应用程序。

环境准备与初始化

在开始构建 REST API 之前，我们需要先设置开发环境。确保已安装 Python 3.7 或更高版本，然后创建一个虚拟环境并安装 Chalice：

python3 -m venv venv37
source venv37/bin/activate
pip install chalice
chalice new-project helloworld
cd helloworld

这会在当前目录下创建一个名为 helloworld 的新项目，其中包含基本的项目结构和示例代码。

基础路由与 URL 参数

Chalice 默认生成的 app.py 文件包含一个简单的示例路由：

from chalice import Chalice

app = Chalice(app_name='helloworld')

@app.route('/')
def index():
    return {'hello': 'world'}

我们可以扩展这个基础路由，添加支持 URL 参数的功能。例如，创建一个根据城市名返回对应州名的 API：

CITIES_TO_STATE = {
    'seattle': 'WA',
    'portland': 'OR',
}

@app.route('/cities/{city}')
def state_of_city(city):
    return {'state': CITIES_TO_STATE[city]}

在这个例子中，{city} 是一个动态参数，会被传递给视图函数 state_of_city。部署后，可以通过 /cities/seattle 和 /cities/portland 访问这些端点。

错误处理机制

当用户请求一个不存在的城市时，我们需要提供友好的错误提示。Chalice 提供了多种内置异常类来处理不同的 HTTP 错误状态：

from chalice import BadRequestError

@app.route('/cities/{city}')
def state_of_city(city):
    try:
        return {'state': CITIES_TO_STATE[city]}
    except KeyError:
        raise BadRequestError(f"Unknown city '{city}', valid choices are: {', '.join(CITIES_TO_STATE.keys())}")

Chalice 支持的错误类型包括：

• BadRequestError (400)
• UnauthorizedError (401)
• ForbiddenError (403)
• NotFoundError (404)
• ConflictError (409)
• UnprocessableEntityError (422)
• TooManyRequestsError (429)
• ChaliceViewError (500)

支持多种 HTTP 方法

Chalice 允许我们为同一个路由指定支持多种 HTTP 方法：

@app.route('/resource/{value}', methods=['PUT'])
def put_test(value):
    return {"value": value}

也可以为不同方法定义不同的处理函数：

@app.route('/myview', methods=['POST'])
def myview_post():
    pass

@app.route('/myview', methods=['PUT'])
def myview_put():
    pass

请求元数据处理

通过 app.current_request 对象，我们可以访问丰富的请求信息：

OBJECTS = {}

@app.route('/objects/{key}', methods=['GET', 'PUT'])
def myobject(key):
    request = app.current_request
    if request.method == 'PUT':
        OBJECTS[key] = request.json_body
    elif request.method == 'GET':
        try:
            return {key: OBJECTS[key]}
        except KeyError:
            raise NotFoundError(key)

current_request 对象提供的主要属性包括：

• query_params - 查询参数
• headers - 请求头
• uri_params - URL 参数
• method - HTTP 方法
• json_body - 解析后的 JSON 请求体
• raw_body - 原始请求体
• context - 上下文信息
• stage_vars - API Gateway 阶段变量

支持多种内容类型

默认情况下，Chalice 只处理 application/json 内容类型。我们可以扩展支持其他内容类型：

from urllib.parse import parse_qs

@app.route('/', methods=['POST'],
           content_types=['application/x-www-form-urlencoded'])
def index():
    parsed = parse_qs(app.current_request.raw_body.decode())
    return {
        'states': parsed.get('states', [])
    }

自定义 HTTP 响应

如果需要更精细地控制响应，可以使用 Response 类：

from chalice import Response

@app.route('/')
def index():
    return Response(body='hello world!',
                    status_code=200,
                    headers={'Content-Type': 'text/plain'})

GZIP 压缩响应

对于返回 JSON 数据的 API，我们可以启用 GZIP 压缩来减少传输数据量：

import json
import gzip
from chalice import Response

app.api.binary_types.append('application/json')

@app.route('/')
def index():
    blob = json.dumps({'hello': 'world'}).encode('utf-8')
    payload = gzip.compress(blob)
    custom_headers = {
        'Content-Type': 'application/json',
        'Content-Encoding': 'gzip'
    }
    return Response(body=payload,
                    status_code=200,
                    headers=custom_headers)

CORS 支持

要启用跨域资源共享(CORS)，可以在路由装饰器中设置 cors=True：

@app.route('/supports-cors', methods=['PUT'], cors=True)
def supports_cors():
    return {}

也可以全局启用 CORS：

app.api.cors = True

通过本教程，我们全面了解了如何使用 AWS Chalice 框架构建功能完善的 REST API，包括路由定义、参数处理、错误处理、请求处理、响应定制等核心功能。Chalice 的简洁 API 和与 AWS 服务的深度集成，使其成为构建无服务器应用的理想选择。