API Designer

API Designer では、2 つの異なるツールを使用して API 仕様を RESTful API Modeling Language (RAML) 0.8 または 1.0 で、もしくは OpenAPI Specification 2.0 (OAS) に準拠して作成し、完成した仕様を Anypoint Exchange にパブリッシュすることができます。

コードエディタ

API 仕様を作成した経験が豊富な場合は、このツールを使用します。自由度が高く、より複雑な仕様を作成することができます。また、仕様に何か問題があるときはエラーや警告を表示します。 このツールの使い方については、「API Designer のコードエディタでの API 仕様の作成およびパブリッシュ」を参照してください。

ビジュアルエディタ

スキャフォールディングをすばやく簡単にデザインおよび作成するには、このツールを使用します。このエディタでは、RAML フラグメントのインポートや、コードエディタで許可されているいくつかのタスクを実行できません。各種フォームに情報を入力することで、API 仕様を作成してくれます。このエディタでスキャフォールディングを作成した後、コードエディタに切り替えて仕様をカスタマイズすることができます。このツールの使い方については、「API Designer のビジュアルコードエディタでの API 仕様の作成およびパブリッシュ」を参照してください。

コードエディタでは、RAML 形式の API フラグメントを作成することもできます。詳しい手順については、「API Designer のコードエディタでの API フラグメントの作成およびパブリッシュ」を参照してください。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub