Swagger ドキュメント

z/OS® Connect API Editor は、API 作成時に Swagger ドキュメントを自動的に生成します。swagger.json ファイルは API プロジェクト内に作成されます。

1. z/OS® Connect Swagger JSON

Swagger ドキュメント・ファイルの例

この内容は、z/OS Connect WLP サーバーから REST API を使用する場合にも利用できます。例:

GET        https://your.server:port/<apiBasePath>/api-docs

ここで、<apiBasePath> は、API Editor で指定されているご使用の API の名前です。

swagger.json の内容は、Swagger UI や Swagger Codegen などの Swagger ドキュメント・エディターで表示できます。または、Eclipse の z/OS Connect EE Servers ビューを使用することもできます。API を右クリックして、Open in Swagger UIメニュー・オプションを選択します。

2. Swagger UI での swagger.json の内容表示

Swagger ドキュメント・ファイルの例