4. 共通定義

共通定義全般については、REST API リファレンス 本編を参照のこと。

4.1. 用語定義

用語	定義
API	API Gateway を使用してBaaS外部に公開する REST API。Swagger 2.0 (OpenAPI 2.0)形式で定義する。 オペレーションのエントリポイントの一覧。0個以上のオペレーションを含む。
オペレーション(operation)	APIを構成する要素で、APIのエントリポイントの1つに対応する。operationId属性で識別する。 Cloud Functions を使用する場合、operationIdにファンクション名を指定し、ファンクションと関連付ける。
ファンクションテーブル(function table)	BaaS内部で定義される、処理(ファンクション)のエントリポイントの一覧。0個以上のファンクションを含む。JSONまたはYAMLで定義する。
ファンクション(function)	ファンクションテーブルを構成する要素(エントリポイント)。 コード属性・ハンドラ属性・環境属性を持つ。JSONまたはYAMLで定義する。
コード(code)	ファンクションを構成する要素。実装コードのファイルを指定する。JSONまたはYAMLで定義し、bucket属性とfile属性を持つ。 実装コードは、BaaSのファイルストレージに配置され、上記のbucket属性・file属性で参照する。 実装コードファイルは、1個以上のハンドラ実装を含む。 コードの具体的な実体は、実装言語によって異なる。Node.jsの場合はnpmパッケージが実体である。
ハンドラ(handler)	ファンクションを構成する要素。文字列である。コード内のハンドラ実装を指定する。 ハンドラ文字列のフォーマットは、実装言語によって異なる。Node.jsの場合は、exports.{function-name}のfunction-nameである。
環境(env)	ファンクションを構成する要素。ファンクションを実行する環境を指定する。spec属性、timeout属性, memorySize属性を含む。 (specは実質的にdockerのイメージ名である)