DX NetOps Spectrum REST API 機能(Swagger)の改善

10.4.1 から、Swagger を使用して
DX NetOps Spectrum
API ドキュメントにアクセスできます。 Swagger UI を使用すると、ビジュアル ドキュメントを提供して、
DX NetOps Spectrum
REST API を視覚化および操作できます。
Swagger ドキュメントおよびエンドポイントにより、
DX NetOps Spectrum
RESTful Web サービスを操作できるようになりました。 REST API エンドポイントが自己記述型のフレームワーク内に用意されているため、メソッドを試し、その結果生成された応答を参照できます。 いずれのメソッドも、リソース タイプ別にグループ化され、単一のウィンドウに表示できます。 リソースとメソッドを展開したり折りたたんだりするには、
[Show/Hide]
[List Operations]
、および
[Expand Operations]
のオプションを使用します。
メソッドは色分けされているので、それぞれのメソッドが区別しやすくなっています。 各メソッドの右側には、そのメソッドで実行されるアクションの簡単な説明があります。 要求パラメータ用のドキュメントが用意されています。 要求内でペイロードを必要とするメソッドでは、サンプル モデル スキーマを使用できます。 この用意されているモデル スキーマを使用して本文フィールドにデータを入力し、デフォルト値を目的の設定に置換します。
[Try it out!]
を使用してみてください。 要求を送信し、生成された応答をリアルタイムで確認するボタン。
各メソッドの
[Response Messages]
セクションには、応答コードがリスト表示されています。 エラー状態が発生した場合には、この情報を参照して修正アクションを判断します。 各要求に対して返される応答は、メソッド ドロップダウン ウィンドウに表示されます。
API ドキュメントへのアクセス
REST API にアクセスするには、OneClick Web インターフェースの
[API Documentation]
メニュー リンクをクリックします。
以下のスクリーンショットは、Swagger インターフェースを示しています。 このインターフェースは、
DX NetOps Spectrum
が備える RESTful Web サービスの一部を表示しています。
Swagger for REST API Documentation
Swagger for REST API の使用の詳細については、Swagger のドキュメントを参照してください。