Swagger (OpenAPI とも呼ばれる) は、言語に依存しない仕様であり、REST API の記述に使用されます。 Web API の対話形式のドキュメントおよびヘルプ ページを生成することで、開発者がサービスの機能を理解するのに役立ちます。
ArcGIS Earth Automation API ページ
ArcGIS Earth Automation API では、Swagger ドキュメントの生成と Swagger UI (情報を提供する Web ベースの UI) の実装に Swashbuckle.AspNetCore というオープン ソース プロジェクトが使用されます。
ArcGIS Earth Automation API を有効にすると、[高度な設定] アプリケーション設定に Swagger リンクが含まれます。 デフォルトの URL は http://localhost:8000/swagger/index.html です。
Swagger UI は、次のように表示されます。
コントローラーの各パブリック アクション メソッドは、Swagger UI からテストすることができます。
- メソッド名をクリックして、セクションを展開します。
- [試してみる] をクリックします。
- 必要なパラメーターをすべて追加します。
- [実行] をクリックします。