作る · API

データから API を作る。

アプリに必要なテーブルを作れば、API が一緒に付いてきます。アプリがすでに使っているサインインの内側に入ります。

生成された REST API のエンドポイントに対応づけられた Orbit のデータモデル画面。

Billing Ops のデータモデルが、生成された REST API のエンドポイントと OpenAPI スキーマに対応します。

仕組み

スキーマから生まれ、既定で範囲が絞られた API。

アプリのデータモデルが、そのまま API も作ります。各エンティティに REST のエンドポイントと OpenAPI スキーマが付きます。アクセスは最初のリクエストから、サインイン中の利用者の範囲で保護されます。

01

すべてのエンティティに、REST エンドポイントを

テーブルを定義すると、API のルートが一緒に付いてきます。/api/v1 の下の GET、POST、PATCH、DELETE です。

生成された REST API のエンドポイントに対応づけられた Orbit のデータモデルのエンティティ。

すべてのエンティティに、REST エンドポイントを

テーブルを定義すると、GET、POST、PATCH、DELETE のルートが付きます。

02

常に同期する、ライブの OpenAPI スキーマ

アプリは /openapi.json に OpenAPI 3.0 ファイルを公開します。API のルートと同じスキーマから生成されるので、クライアント、コード生成ツール、AI エージェントは常に最新版を見ます。

ライブの OpenAPI スキーマと同期した Orbit のデータモデル。

常に同期する、ライブの OpenAPI スキーマ

アプリは、API のルートと同じスキーマから生成された OpenAPI 3.0 ファイルを公開します。

03

既定で範囲が絞られ、保護されます。

各リクエストは、まずサインイン中の利用者を確認します。そのうえで Orbit が結果を絞るので、利用者は許可されたデータだけを見ます。

ここまでです。アクセスはアプリの利用者セッションに基づくので、これはアプリの裏側の API であり、キーを発行する公開 API ではありません。公開 API トークンは準備中です。

サインイン中の利用者の組織で絞り込まれた、Orbit の API リクエスト。

既定で範囲が絞られ、保護されます。

各リクエストはまずサインイン中の利用者を確認し、許可されたデータだけに結果を絞ります。

どこに位置するか

API は、データの投影です。

API を別に作ることはありません。データモデルから生まれるので、スキーマが変われば API も一緒に変わります。

定型コードなしで、エンドポイントを手に入れる

データモデルを定義すれば、最初から利用者の範囲に絞られた、ドキュメント付きの API が手に入ります。

OrbitMade in Orbit