Function Compute:HTTP handlers

ハンドラの署名

すべての HTTP ハンドラは、WSGI 署名に従います。

def handler(environ, start_response):
    start_response('200 OK', [('Content-Type', 'text/html')])
    return [b'<h1>Hello, world!</h1>']

戻り値はイテラブルである必要があります。return [b'<h1>Hello, world!</h1>'] は、単一のバイトオブジェクトを含むリストを返し、ランタイムはこれを HTTP レスポンスボディとしてクライアントに送信します。

WSGI 仕様の完全な詳細については、「PEP 3333」をご参照ください。

Flask アプリケーションの Function Compute への移行

HTTP ハンドラは WSGI 仕様に従うため、Flask および Django アプリケーションは、Function Compute で実行するために単一のアダプター関数のみを必要とします。

以下の例は、Python 3 ランタイムで Flask の hello world アプリケーションを実行します。

# Flask application — define routes as usual
from flask import Flask

app = Flask(__name__)

@app.route('/')
def index():
    return 'Web App with Python Flask!'

# FC handler — forwards every request to the Flask WSGI app
def handler(environ, start_response):
    return app(environ, start_response)

この例には 2 つの部分があります。

• Flask アプリケーション (1～7 行目): 標準的な Flask コードです。変更は不要です。

• FC ハンドラ (9～11 行目): environ と start_response を Flask アプリケーションに直接渡す最小限のアダプターです。この 1 行だけで、WSGI 互換の任意のフレームワークを Function Compute で実行できます。

リクエストフィールド (environ)

environ は、すべての HTTP リクエストデータを含む Python ディクショナリです。以下の表に、Function Compute ハンドラで最も一般的に使用されるフィールドを示します。フィールドの完全なリストについては、「environ 変数」をご参照ください。

次の例は、environ から一般的なフィールドを読み取ります。

HELLO_WORLD = b"Hello world!\n"

def handler(environ, start_response):
    # FC-specific context and request URI
    context = environ['fc.context']
    request_uri = environ['fc.request_uri']

    # Iterate over custom request headers (all start with HTTP_)
    for k, v in environ.items():
        if k.startswith("HTTP_"):
            pass  # process custom headers here

    # Read request body
    try:
        request_body_size = int(environ.get('CONTENT_LENGTH', 0))
    except ValueError:
        request_body_size = 0
    request_body = environ['wsgi.input'].read(request_body_size)

    # Read other common fields
    request_method = environ['REQUEST_METHOD']
    path_info = environ['PATH_INFO']
    server_protocol = environ['SERVER_PROTOCOL']

    try:
        content_type = environ['CONTENT_TYPE']
    except KeyError:
        content_type = " "

    try:
        query_string = environ['QUERY_STRING']
    except KeyError:
        query_string = " "

    print('request_body: {}'.format(request_body))
    print('method: {}\n path: {}\n query_string: {}\n server_protocol: {}\n'.format(
        request_method, path_info, query_string, server_protocol))

    status = '200 OK'
    response_headers = [('Content-type', 'text/plain')]
    start_response(status, response_headers)
    return [HELLO_WORLD]  # return value must be iterable

レスポンス構造体 (start_response)

レスポンスボディを返す前に、start_response を呼び出してレスポンスステータスとヘッダーを設定します。FC ランタイムは、次の署名を持つこの呼び出し可能なものを提供します。

# Provided by FC runtime.
# status: a string like '200 OK' or '403 FORBIDDEN'
# return: must be a write(body_data) callable
def start_response(status, response_headers, exc_info=None):
    ...

完全な仕様については、「start_response() 呼び出し可能」をご参照ください。

ハンドラによって返されるレスポンスボディは、イテラブルオブジェクトである必要があります。

制限事項

次のステップ

• HTTP リクエストで関数を呼び出す HTTP トリガーの設定

• 関数を作成する