API 仕様とフラグメントの設計
Anypoint Code Builder を使用して、新しい API 仕様の作成、設計、テスト、および Exchange へのパブリッシュを行います。
API 仕様を設計するプロセスは、次のとおりです。
ソース管理オプションについては、SCM for API Design Projects (API 設計プロジェクトの SCM) を参照してください。
API 仕様でサポートされる OAS および RAML バージョン
サポートされる OAS および RAML バージョンは、次のとおりです。
-
OAS 2.0 (JSON)
-
OAS 2.0 (YAML)
-
OAS 3.0 (JSON)
-
OAS 3.0 (YAML)
-
RAML 1.0
-
RAML 0.8
API フラグメントでサポートされる仕様言語
API フラグメントを API 仕様内に作成するか、含めるか、参照します。
API フラグメントでサポートされる API 仕様言語と構文は、次のとおりです。
-
OAS 3.0
-
YAML
-
JSON
-
-
RAML 1.0
これらの種別の詳細は、RAML 1.0 仕様を参照してください。
-
特性
-
リソース
-
ライブラリ
-
データ型
-
ユーザードキュメント
-
例
-
-
JSON スキーマ
API 設計プロジェクトのソース制御
ソース制御管理 (SCM) を使用して、設計、インテグレーション、実装プロジェクトを保存および共有します。 API 設計プロジェクトのソース制御オプションは、プロジェクトの作成方法とタイミングによって異なります。
-
2024 年 2 月リリース以降、Anypoint Code Builder で [Design an API (API を設計)] (新しい API 仕様プロジェクトを作成するを参照) またはコマンド
MuleSoft: Design an API を使用して最初から作成した設計プロジェクトでは、対応する設計プロジェクトを Design Center に生成したり、Anypoint SCM を使用して変更を保存および同期したりしなくなります。 -
Design Center から Anypoint Code Builder にインポートされたか、2024 年 2 月リリースより前に Anypoint Code Builder で作成された API 設計プロジェクトは、Anypoint SCM に自動的に接続され、Design Center の対応する設計プロジェクトと同期できるようになります。
独自のリモートリポジトリを使用する場合は、GitHub を使用することもできます。Design Center のプロジェクトと同期せずに API プロジェクトを GitHub のリポジトリに保存するには、publish your project files to another repository (別のリポジトリへのプロジェクトファイルのパブリッシュ) を参照してください。
ソース制御オプションについては、ソースファイルの制御を参照してください。