アダプタ定義ドキュメントの確認および更新

Postmanコレクション(またはOpenAPIドキュメント)をアダプタ定義ドキュメントに変換した後、生成されたドキュメントを確認し、要件に従って変更できます。

Rapid Adapter Builderは、Postmanコレクション(またはOpenAPIドキュメント)のデータからドキュメントの様々なコンポーネントを自動的に移入します。ただし、変換されたアダプタ定義ドキュメントをほとんど変更せずに公開すると、機能アダプタがある場合がありますが、エンドポイント構成またはマッパー要素に関するユーザー・エクスペリエンスが最適でない場合があります。そのため、ドキュメントを確認し、アダプタに必要な変更を加える必要があります。

特に、ドキュメント内のインタフェース(アダプタ・エンドポイント構成インタフェースなど)を拡張またはオーバーライドしたり、ドキュメントに新しい機能を追加できます。

VS Codeで、サイドバーの「エクスプローラ」をクリックします。
ワークスペース・フォルダのディレクトリ構造が表示されます。
「定義」ディレクトリ・リストをクリックして展開します。
確認または更新するアダプタ定義ドキュメントをクリックします。
ドキュメントがVS Codeエディタに表示されます。
必要に応じてドキュメントを更新します。アダプタ定義ドキュメントの様々なセクションを更新する方法のガイドラインは、「アダプタ定義ドキュメントの使用」を参照してください。
ノート:
変換後は、少なくとも次の詳細をアダプタ定義ドキュメントに追加する必要があります:
- 一意のID 「情報定義の追加」を参照してください。
- 認証スキーム。「認証スキーム・テンプレートの使用」を参照してください。

次のステップ: アダプタ定義ドキュメントの検証