3.5. Swagger ドキュメントの有効化
Red Hat Decision Manager ビジネスアプリケーションのサービスプロジェクトで利用可能なすべてのエンドポイントに関する Swagger ベースのドキュメントを有効にできます。
前提条件
-
business applicationsの Web サイトを使用して作成した <business-application>.zip ファイルがある。
手順
-
<business-application>.zipファイルを展開して、<business-application>/<business-application>-serviceフォルダーに移動します。 -
テキストエディターでサービスプロジェクト
pom.xmlファイルを開きます。 サービスプロジェクトの
pom.xmlファイルに以下の依存関係を追加して、このファイルを保存します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow Swagger UI を有効にするには (任意)、以下の依存関係を
pom.xmlファイルに追加して、このファイルを保存します。<dependency> <groupId>org.webjars</groupId> <artifactId>swagger-ui</artifactId> <version>2.2.10</version> </dependency>
<dependency> <groupId>org.webjars</groupId> <artifactId>swagger-ui</artifactId> <version>2.2.10</version> </dependency>Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
テキストエディターで
<business-application>/<business-application>-service/src/main/resources/application.propertiesファイルを開きます。 Swagger サポートを有効にするには、以下の行を
application.propertiesファイルに追加します。kieserver.swagger.enabled=true
kieserver.swagger.enabled=trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow
ビジネスアプリケーションの起動後に、http://localhost:8090/rest/swagger.json で Swagger ドキュメントを表示できます。エンドポイントの完全なセットは、http://localhost:8090/rest/api-docs/?url=../swagger.json から入手できます。