Falcon框架WSGI开发教程：构建图像分享API-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00980/article/details/148417385

Falcon框架WSGI开发教程：构建图像分享API

falcon The no-magic web data plane API and microservices framework for Python developers, with a focus on reliability, correctness, and performance at scale. 项目地址: https://gitcode.com/gh_mirrors/fa/falcon

前言

Falcon是一个轻量级的Python Web框架，专为构建快速、可靠的RESTful API而设计。本教程将带您从零开始，使用Falcon框架开发一个简单的图像分享服务API，过程中会详细介绍Falcon的核心概念和特性。

环境准备

在开始之前，我们需要设置开发环境：

mkdir look
cd look
python -m venv .venv
source .venv/bin/activate  # Linux/macOS
.venv\Scripts\activate     # Windows

安装Falcon框架：

pip install falcon

创建项目结构：

mkdir look
touch look/__init__.py
touch look/app.py

创建基础应用

在app.py中创建最基本的Falcon应用：

import falcon

app = application = falcon.App()

这个简单的代码创建了一个WSGI应用实例。application是Gunicorn等服务器默认查找的变量名。

运行应用

为了测试我们的应用，我们需要一个WSGI服务器：

安装Gunicorn（Windows用户可以使用Waitress）：

pip install gunicorn

启动服务器：

gunicorn --reload look.app

使用--reload参数可以让服务器在代码变更时自动重启。

创建第一个资源

在REST架构中，资源是API的核心概念。让我们创建一个图像资源：

创建look/images.py文件：

import json
import falcon

class Resource:
    def on_get(self, req, resp):
        doc = {
            'images': [
                {
                    'href': '/images/1eaf6ef1-7f2d-4ecc-a8d5-6e8adba7cc0e.png'
                }
            ]
        }
        resp.text = json.dumps(doc, ensure_ascii=False)
        resp.status = falcon.HTTP_200

在app.py中注册路由：

from .images import Resource

app = application = falcon.App()
images = Resource()
app.add_route('/images', images)

测试API

我们可以使用HTTPie或curl测试API：

http GET localhost:8000/images

应该会得到200响应和JSON格式的图像列表。

使用MessagePack替代JSON

Falcon支持多种媒体类型。让我们改用MessagePack：

安装MessagePack：

pip install msgpack-python

修改资源类：

import msgpack

class Resource:
    def on_get(self, req, resp):
        doc = {
            'images': [
                {
                    'href': '/images/1eaf6ef1-7f2d-4ecc-a8d5-6e8adba7cc0e.png'
                }
            ]
        }
        resp.data = msgpack.packb(doc, use_bin_type=True)
        resp.content_type = falcon.MEDIA_MSGPACK
        resp.status = falcon.HTTP_200

编写测试

良好的测试是API稳定性的保障。让我们为应用添加测试：

mkdir tests
touch tests/__init__.py
touch tests/test_app.py

安装pytest：

pip install pytest

编写测试用例：

import msgpack
import pytest
import falcon
from falcon import testing
from look.app import app

@pytest.fixture
def client():
    return testing.TestClient(app)

def test_list_images(client):
    doc = {
        'images': [
            {
                'href': '/images/1eaf6ef1-7f2d-4ecc-a8d5-6e8adba7cc0e.png'
            }
        ]
    }
    response = client.simulate_get('/images')
    result_doc = msgpack.unpackb(response.content, raw=False)
    assert result_doc == doc
    assert response.status == falcon.HTTP_OK

运行测试：

pytest tests

处理POST请求

让我们扩展API以支持上传新图像：

添加测试用例：

from unittest.mock import mock_open, call

def test_posted_image_gets_saved(client, monkeypatch):
    mock_file_open = mock_open()
    monkeypatch.setattr('io.open', mock_file_open)
    
    fake_uuid = '123e4567-e89b-12d3-a456-426655440000'
    monkeypatch.setattr('uuid.uuid4', lambda: fake_uuid)
    
    fake_image_bytes = b'fake-image-bytes'
    response = client.simulate_post(
        '/images',
        body=fake_image_bytes,
        headers={'content-type': 'image/png'}
    )
    
    assert response.status == falcon.HTTP_CREATED
    assert call().write(fake_image_bytes) in mock_file_open.mock_calls

实现POST处理：

import io
import os
import uuid

class Resource:
    # ... 保留现有的on_get方法
    
    def on_post(self, req, resp):
        ext = req.content_type.split('/')[-1]
        filename = f"{uuid.uuid4()}.{ext}"
        
        image_path = os.path.join('./', filename)
        with io.open(image_path, 'wb') as image_file:
            image_file.write(req.stream.read())
        
        resp.status = falcon.HTTP_CREATED
        resp.location = f'/images/{filename}'