1. はじめに

本文書は、モバイルバックエンド基盤 Cloud Functionsの開発ガイドです。

本文書では、Cloud Functionsのセットアップ手順とCloud Functionsの開発方法・ 実行方法について解説します。

1.1. Cloud Functionsとは

モバイルバックエンド基盤 Cloud Functionsは、以下２つの機能から成り立っています。

1.1.1. Cloud Functions実行基盤

利用者が作成したファンクションをサーバ上で実行する基盤です。

利用者は JavaScript または Java で記述した任意のファンクションを、モバイルバックエンド基盤 サーバ上の Node.js 環境および Java 環境で実行することができます。

1.1.2. API Gateway

モバイルバックエンド基盤サーバ上に、ユーザが定義した任意の REST API を搭載することができます。

REST API の定義は、 Swagger で記述します。 Swagger 定義ファイルをモバイルバックエンド基盤サーバにアップロードすることで、 REST API が使用できるようになります。

カスタム REST API は上記Cloud Functionsを紐付けることができますので、 利用者は任意のCloud Functionsをカスタム REST API を経由して呼び出すことができます。

注釈

Cloud Functionsは、上記のカスタム REST API経由での呼び出しだけでなく、イベント駆動で呼び出すこともできます。

詳細は、 イベント駆動 開発ガイド を参照してください。

1.2. 用語の定義

本マニュアルでは以下の用語定義を使用します。

  • Cloud Functions: 利用者が定義した機能(ファンクション)をサーバ上で実行する基盤。
  • ファンクション: Cloud Functions 上で動作するユーザ定義機能。
  • ファンクション定義: ファンクションの定義ファイル。JSONで記述する。API とコード・ハンドラの間をひも付ける。
  • コード(またはユーザコード): ファンクションの実装プログラムコード。
  • ハンドラ: コード内に実装されたプログラムエントリポイント。
  • API(またはカスタムAPI) : 利用者が定義した REST API。Swagger で記述。

1.3. 動作環境

Cloud Functionsの開発には、クライアント側に以下の環境が必要です。

  • Node.js v6.2.0 以上

Cloud Functionsの動作には、以下のサーバが必要になります。