API デザイナー

API デザイナー を使えば、完全な API を Restorm の中で直接設計できます。 データとルートを記述すれば、あとは Restorm が引き受けます。設計を本物のモック サーバーのように 提供 し、テンプレートからアプリケーションのコードを 生成 します。

バックエンドがまだ存在しない段階で API を始めるのに最適なツールです。契約を モックとして組み立て、クライアントにテストしてもらい、そのすべてをプロジェクト 内でバージョン管理された状態に保ちます。

1 つの設計、複数のセクション

設計はほかの要素と同じように作成します。フォルダーを右クリック ▸ 追加 ▸ API 設計。専用のタブで開き、サイドバーからアクセスできる複数のセクションを まとめています。

セクション	役割
モデル	エンティティとそのプロパティ — モデル、enum、プロパティ を参照。
Enum	プロパティの型として再利用できる、閉じた値の集合。
ルート	リソースごとにまとめられた API のエントリーポイント — ルートと CRUD を参照。
サーバー	設計を HTTP、GraphQL、SOAP、OData、gRPC のモックとして提供 — 設計をモックとして提供する を参照。
クライアント	実行中のモックを呼び出す、すぐに使えるリクエスト — クライアント を参照。
ドキュメント と メモ	設計に付随する自由なドキュメントとメモ。
コード	自分のテンプレートからのコード生成 — コード生成 を参照。

設計の 設定（名前、デフォルト値）は、サイドバーの設計ノードを直接クリック すると開きます。

典型的な流れ

1. データを記述する — モデルと enum を作成し、そのプロパティ、型、制約を 追加します。
2. ルートを定義する — 手作業で、あるいはモデルから CRUD を生成 で ワンクリックで。
3. モックを提供する — サーバーを起動し、アプリケーションやクライアントを そこに向けます。同じ設計が、有効化された各プロトコルへ自動的に投影されます。
4. コードを生成する — 1 つ以上のテンプレート（自分のもの、または Restorm が 提供するもの）を選び、対応するプロジェクトを生成します。

各ステップは、このセクションの各ページで詳しく説明します。