OpenAPI とは、また、それを使用すべき理由
OpenAPI は、Web API に対する標準およびプログラミング言語に依存しないインターフェースの記述を定義します。 これにより、人間とコンピュータは、ソース コードや他のドキュメントへアクセスしたり、またはネットワーク トラフィックを検査したりする必要なく、サービスの機能を見つけて理解できます。
Web API を記述する OpenAPI ドキュメントを使用すると、消費者は最小限の労力で Web API を理解して通信することができます。
OpenAPI ドキュメントによって適切に記述されている限り、カスタム コネクタは任意の Web API に対して作成できます。 つまり、VanArsdel フュージョン開発チームは、Azure API Management でホストされる Web API からの Power Apps アプリケーション用のカスタム コネクタ作成に限定されません。
OpenAPI ドキュメントの役割
OpenAPI ドキュメントは、Web API の表面領域の契約を指定します。 API の消費者から離れて、実際の実装の詳細を抽象化します。 つまり、呼び出すメソッドおよびメソッドが返す内容を知ることで、それらのメソッドが呼び出される方法について気に掛けることなく、アプリケーションを素早く作成できます。
前のユニットでは、Azure API Management を使用してカスタム コネクタを作成しました。 そうすることで、Azure API Management の依存関係も作成しました。 つまり、Azure API Management で変更が行われる場合は、変更を反映するためにカスタム コネクタを更新する必要があります。
OpenAPI ドキュメントを使用すれば、API の位置や API が実行中であるかどうかを把握しておく必要がなくなります。ドキュメントには必要な情報がすべて含まれているためです。
Power Apps を使用すると、この OpenAPI ドキュメントを使用してカスタム コネクタを作成できます。
OpenAPI ドキュメントからカスタム コネクタを作成すると、そのカスタム コネクタが Power Apps ページに表示されます。
カスタム コネクタに対して OpenAPI ドキュメントを使用する理由
OpenAPI ドキュメントをカスタム コネクタ作成に使用することには、さまざまな利点があります。 ただし、市民開発者にとって最も重要な利点は次の 2 つです。
- 依存関係の削除: OpenAPI ドキュメントを使用すると、誰かに API Management からカスタム コネクタを作成してもらうのを待つ必要なく、自身でカスタム コネクタを作成できます。 また、専門的な開発チームでは、Web API 自体に OpenAPI ドキュメント生成機能を含めるのが一般的になっています。 つまり、URL にアクセスして OpenAPI ドキュメントをダウンロードし、それを使用してカスタム コネクタを作成できるということです。
- アジリティの向上: Web API 開発チームが OpenAPI ドキュメントを提供できると、Power App の開発のペースが上がります。 カスタム コネクタの作成と使用について、今後彼らに依存する必要がなくなります。
次の図に示すように、契約が同じである限り、OpenAPI ドキュメントに Web API の実際の実装に関する情報は必要ありません。
OpenAPI ドキュメントまたは Azure API Management からのカスタム コネクタ
カスタム コネクタを作成するには、Azure API Management または OpenAPI ドキュメントのいずれかを使用します。 どちらを選択すべきか
次の表は、カスタム コネクタに Azure API Management を使用する場合と OpenAPI を使用する場合の比較を示しています。
| コネクタ | Azure API Management | OpenAPI ドキュメント |
|---|---|---|
| API コントロール | 集中型 | 分散的 |
| API 構造レイヤー | 複雑 | シンプル |
| 追加のセキュリティ レイヤー | あり | なし |
| 使用状況の管理 | あり | なし |
| 追加費用 | あり | なし |
| アーキテクチャの複雑さ | より高い | より低い |