第6章 Spring Web サンプルの OpenAPI および Swagger-UI サポートの有効化

手順

1. 以下のコマンドを入力し、quarkus-smallrye-openapi エクステンションを Spring Web サンプルの依存関係として追加します。REST エンドポイントから基本的な OpenAPI スキーマドキュメントを生成するには、エクステンションを追加するだけで十分です。

   ./mvnw quarkus:add-extension -Dextensions="io.quarkus:quarkus-smallrye-openapi"

   Copy to Clipboard Toggle word wrap

   このコマンドにより、以下の依存関係が pom.xml に追加されます。

   pom.xml

   <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-smallrye-openapi</artifactId>
   </dependency>

   Copy to Clipboard Toggle word wrap

2. 以下のコマンドを入力して、/q/openapi からスキーマドキュメントを取得します。

   curl http://localhost:8080/q/openapi

   Copy to Clipboard Toggle word wrap

   YAML 形式の生成された OpenAPI スキーマドキュメントでレスポンスを受け取ります。

   ---
   openapi: 3.0.3
   info:
     title: Generated API
     version: "1.0"
   paths:
     /greeting:
       get:
         responses:
           "200":
             description: OK
             content:
               text/plain:
                 schema:
                   type: string
     /greeting/{name}:
       get:
         parameters:
         - name: name
           in: path
           required: true
           schema:
             type: string
         responses:
           "200":
             description: OK
             content:
               application/json:
                 schema:
                   $ref: '#/components/schemas/Greeting'
   components:
     schemas:
       Greeting:
         type: object
         properties:
           message:
             type: string

   Copy to Clipboard Toggle word wrap