Category
Morph as Backend
Tag
Basics
アプリケーションのバックエンドとしてMorphを使用する
MorphのテーブルにAPIを作成することができ、外部のプログラムやサーバーからアクセスすることができます。
これにより、Morphのデータを外部ツールに接続したり、フロントエンドアプリケーションのためのノーコードバックエンドとして使用したりすることができます。
それぞれのAPIには一意のAPIキーが発行され、アクセスを制限するために使用されます。
テーブルにAPIを作成する
テーブルのAPIを作成するには、テーブル画面の右上にある’+Create’ボタンをクリックし、ドロップダウンメニューから作成したいデータAPIの種類を選択してください。
APIの種類
Morphは以下の種類のテーブルAPIをサポートしています
- Query: レコードのリストを取得する
- Create: 新しいレコードを作成する
- Update: 既存のレコードを更新する
- Delete: 既存のレコードを削除する
- Upload: 画像やファイルをアップロードする
- Download: CSV形式でレコードのリストをダウンロードする
- Aggregate: テーブルに対して集計やグループ化を行い、その結果を取り出す
APIタイプの設定
Query API, Download API
Query APIとDownload APIには以下のルールを設定できます:
- Select: APIに公開するフィールドを選択します。
- Mask: 収集結果をマスクするフィールドを選択します。ここで指定するフィールドは、Selectでも指定する必要があります。
- Filter: フィルタリング条件を指定できます。ここで設定したフィルタリング条件は常に適用されます。APIを実行する際に、追加のフィルタリング条件を指定することもできます。
- Sort: ソート条件を指定することができます。ここで設定したソート条件は常に適用されます。APIを実行する際に、追加のソート条件を指定することもできます。
Create API, Update API
Create APIとUpdate APIには以下のルールを設定できます:
- Fixed values: APIリクエストの内容に関係なく、挿入したいデフォルト値を設定します。
Aggregate API
Aggregate APIには以下のルールを設定できます:
- Aggregation: 集計するフィールドを選択します。集計関数には、合計、カウント、平均、中央値などがあります。
- Group keys:特定のフィールドの値で集計結果をグループ化したい場合は、ここでフィールドを指定できます。
- Filter:フィルタリング条件を指定します。ここで設定したフィルタリング条件は常に適用されます。APIを実行する際に、追加のフィルタリング条件を指定することもできます。
- Sort: ソート条件を指定します。ここで設定したソート条件は常に適用されます。APIを実行する際に、追加のソート条件を指定することもできます。
Delete API, Upload API
Delete APIやUpload APIには追加の設定ルールはありません。必要なパラメータは実行時に指定されます。
API documentation.
APIの詳細な仕様については、APIドキュメントを参照してください。