QuarkusでSwagger UIを見るには拡張機能としてSmallRye OpenAPI
を追加します。
Swagger UIへのアクセスはホスト名にswagger-ui
を追加するとアクセスできるようになります。
拡張機能を追加する方法は以下の3つあります。
- https://code.quarkus.io/で作成時に追加
- maven で作成時に追加
- 既存のQuarkusプロジェクトに追加
今回は既存のQuarkusプロジェクトに追加する方法を紹介します。既存のQuarkusプロジェクトに新たな拡張機能を追加するにはquarkus:add-extension
を使い、-Dextensions
で追加したい拡張機能を指定します。
今回拡張したい追加機能はio.quarkus:quarkus-smallrye-openapi
なので、以下のようになります。
mvn quarkus:add-extension -Dextensions="io.quarkus:quarkus-smallrye-openapi"
実行例は以下の通りです。
> mvnw quarkus:add-extension -Dextensions="io.quarkus:quarkus-smallrye-openapi" [INFO] Scanning for projects... [INFO] [INFO] -------------------< chiroito.quarkus:spring-sample >------------------- [INFO] Building spring-sample 1.0-SNAPSHOT [INFO] --------------------------------[ jar ]--------------------------------- [INFO] [INFO] --- quarkus-maven-plugin:1.0.1.Final:add-extension (default-cli) @ spring-sample --- ? Adding dependency io.quarkus:quarkus-smallrye-openapi:jar [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 2.425 s [INFO] Finished at: 2019-12-04T12:08:08+09:00 [INFO] ------------------------------------------------------------------------
これでSwagger UIのページにアクセスできるようになったと思います。