技術者向けを閲覧中業務担当者向けへ →
メインコンテンツまでスキップ

マイクロサービス API（MicroService API）​

マイクロサービス API は、業務ロジックとデータ管理のための REST API を構築する仕組みです。

コンソール上でデータ構造（スキーマ）を定義するだけで、CRUD 操作のエンドポイントが自動生成されます。
認証・データ結合・カスタムロジックの追加など、本格的な業務 API に必要な機能を備えています。

1 つのシステムに複数のマイクロサービス API を構築し、それぞれが独立したデータベースを持つことで、
サービスを小さく分割し、変更の影響範囲を最小化したアーキテクチャを実現できます。

スキーマ定義と API の自動生成​

マイクロサービス API の構築は、コンソール上でのスキーマ定義から始まります。

  • エンドポイント名 を設定します
  • フィールド（カラム）とその型（文字列・数値・日付・真偽値など）を定義します
  • 各エンドポイントに対して認証が必要かどうかを設定します

エンドポイント名の隠蔽​

エンドポイント名は、外部からアクセスされる実際の URL パスに使われます。
業務の文脈が推測されるような名前を公開したくない場合は、エンドポイント名を隠蔽できます。
隠蔽を有効にすると、コンソールで設定した名前は内部管理にのみ使用され、
外部に公開される URL はランダムな識別子に置き換えられます。

提供されるインターフェース​

定義が完了すると、以下の操作に対応する REST API エンドポイントが自動生成されます。

操作説明
一覧取得全レコードを取得（検索・ページング対応）
1 件取得ID を指定して 1 件取得
件数取得 (Count)条件に一致するレコード件数を取得
存在確認 (Exist)条件に一致するレコードの存在を確認（true / false）
作成新規レコードを 1 件作成
一括作成 (Bulk Create)複数レコードをまとめて作成
更新指定レコードを 1 件更新
一括更新 (Bulk Update)複数レコードをまとめて更新
削除指定レコードを 1 件削除
一括削除 (Bulk Delete)複数レコードをまとめて削除

各エンドポイントは、以下の3種類のアクセス設定から選択できます。

設定概要
管理者用管理者ユーザーのみがアクセスできる Admin エンドポイントとして提供
認証なし（公開）認証不要でアクセスできる公開エンドポイントとして提供
組織スコープ認証済みユーザーがアクセスでき、自分が所属する Organization のデータのみ操作できるよう制限

アクセス制御（IAM API との連携）​

エンドポイントごとに、認証・認可を有効にするかどうかを選択できます。

認証を有効にすると、IAM API と連携して以下の制御が適用されます。

  • ユーザー認証 — IAM API のトークンを持つユーザーのみアクセスを許可
  • RBAC — IAM API で定義した Role / Permission に基づいてアクセスを制御
  • 組織スコープ — 自分が所属する Organization のデータのみ操作できるよう制限
  • Admin エンドポイント — 管理者ユーザーのみがアクセスできる専用エンドポイントを有効化

データベース​

マイクロサービス API は、環境に応じて 2 種類のデータベースエンジンを使い分けできます。

エンジン用途特徴
In-MemoryTestEnv / DevelopEnv永続化なし。再起動でデータがリセットされる。テスト・開発・デモ用途に最適
PostgreSQLStagingEnv / ProductionEnv永続化あり。本番運用に対応したリレーショナルデータベース

各マイクロサービス API は専用のデータベースとして払い出されるため、他の API のデータと混在しません。

データ結合（リレーション）​

複数のスキーマをリレーションで結合した API を構築できます。

例えば orders スキーマが users スキーマを参照するよう設定すると、
注文情報にユーザー情報を結合したレスポンスを返す API を自動生成できます。

スキーマ間のリレーションはコンソール上で設定でき、SQL のような手書きクエリは不要です。

データ分析インデックス​

コンソール上でデータの集計・絞り込み・可視化を行える分析インデックス機能を提供しています。
API を別途作らなくても、蓄積したデータをコンソール上でリアルタイムに確認できます。

カスタムコード（Embed Code）​

スキーマ定義だけでは対応できないビジネスロジックは、カスタムコード（Embed Code） で拡張できます。

エンドポイントの「前処理」または「後処理」にカスタムコードを挿入することで、
データのバリデーション・外部 API の呼び出し・通知送信など、任意の処理を追加できます。

詳細 → カスタムコード（Embed Code）

OpenAPI 仕様の自動生成​

構築したエンドポイントの OpenAPI 仕様がコンソール上で自動生成されます。
フロントエンドチームや外部連携先への仕様共有、TypeScript クライアント SDK の自動生成に活用できます。

バージョン管理​

すべてのマイクロサービス API にはバージョンが付与されます。
変更を本番に反映する際はアップグレード、問題が起きた際はロールバックをコンソールから実行できます。

詳細 → アップグレード・ロールバック

インターフェース​

マイクロサービス API は標準的な HTTP/1 系 REST API として提供されます。
既存システム・フロントエンド・外部サービス・AI Agent から、HTTP クライアントがあればどこからでも接続できます。