外部ファイルからの API 仕様またはフラグメントの作成とパブリッシュ
API Designer を使用して既存の外部ファイルから新しい API 仕様または API フラグメントを作成します。API Designer では、JSON ファイル、RAML ファイル、または YML ファイルからのインポートがサポートされます。既存のプロジェクトから API 仕様とフラグメントをインポートすることもできます。
手順
-
Design Center の [Projects (プロジェクト)] ページで [Create (作成)] ボタンをクリックし、[Import from File (ファイルからインポート)] をクリックします。
-
インポートするプロジェクトに付ける名前を指定します。
-
[Choose file (ファイルを選択)] をクリックしてから、インポートするプロジェクトのファイルシステムを参照します。
次のファイルの種類から新しいプロジェクトを作成できます。
-
JSON
-
RAML
-
YAML
-
既存のプロジェクトが含まれる ZIP ファイル。
-
-
[Import as… (名前を付けてインポート)] をクリックして [API Specification (API 仕様)] または [API Fragment (API フラグメント)] を選択します。
API Designer でテキストエディターを使用して API 仕様またはフラグメントが新しいプロジェクトで開きます。API Designer ではプロジェクトの各ファイルに既存の名前が使用されます。これらの名前は必要に応じて変更できます。
API 仕様またはフラグメントの変更
エディターでの作業中には、仕様内を移動したり、仕様の内容を操作したりできます。F1 キーを押すと、いつでもこれらのリストが表示されます。このリストには、大半のコマンドのキーボードショートカットも表示されます。
以下のタスクも実行できます。
- プロジェクトへのファイルと API フラグメントのインポート
-
ファイルを 1 つずつ、または ZIP ファイルにまとめてインポートできます。RAML 1.0 ファイル、JSON ファイル、OpenAPI Specification (OAS) 2.0 または 3.0 ファイル (JSON または YAML) がサポートされています。コンピューター上のローカルファイルを指定するか、またはファイルがオンラインで保存されている場合は URL を指定できます。
ファイルのインポートについての詳細とインポート手順は、このトピックの最後にある「関連情報」にリンクがある「API プロジェクトへのファイルのインポート」を参照してください。
プロジェクトへの API フラグメントの追加についての詳細は、このトピックの最後にある「関連情報」にリンクがある「API 仕様プロジェクトへの連動関係としての RAML API フラグメントの追加」を参照してください。
- API コールのシミュレーション
-
API 仕様の作成中であっても、以下を指定したエンドポイントへのコールをシミュレートすることができます。
-
API が成功時に返す HTTP ステータスコード
-
実際の実装が返すデータの例
詳細は、「API コールのシミュレーション」を参照してください。
-
- API プロジェクトまたは仕様のエクスポート
-
プロジェクトはいつでも ZIP ファイルとしてエクスポートできます。テキストエディターの右上隅にある歯車アイコンをクリックして [Download Project (プロジェクトをダウンロード)] を選択します。
- ファイルのダウンロード
-
ファイル名の右側にあるドットをクリックして [Download (ダウンロード)] を選択します。
- 別の形式でのファイルのダウンロード
-
仕様のファイル名の右側にあるドットをクリックして [Download as (名前を付けてダウンロード)] を選択します。仕様は、サポートされている他の形式のいずれかでダウンロードできます。仕様が RAML 形式であれば、OAS YAML または OAS JSON 形式でダウンロードできます。仕様が OAS 形式であれば、RAML 0.8 または RAML 1.0 形式でダウンロードできます。
このオプションを使用してダウンロードしたファイルが有効である保証はありません。このオプションの目的は、新しい仕様の開発の基礎を提供すること、または新しい形式で元の仕様の開発を継続できるようにすることです。
次のステップ
API 仕様が完成したら、Exchange にパブリッシュすることができます。「API 仕様のパブリッシュ」を参照してください。