Spring Web API の Quarkus エクステンションの使用

手順

1. 以下のコードを含む src/main/java/org/acme/spring/web/GreetingController.java ファイルを作成します。

   src/main/java/org/acme/spring/web/GreetingController.java

   package org.acme.spring.web;
   
   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.RequestMapping;
   import org.springframework.web.bind.annotation.RestController;
   
   @RestController
   @RequestMapping("/greeting")
   public class GreetingController {
   
       @GetMapping
       public String hello() {
           return "Hello Spring";
       }
   }

   Copy to Clipboard Toggle word wrap

2. 以下のコードを含む src/test/java/org/acme/spring/web/GreetingControllerTest.java ファイルを作成します。

   src/test/java/org/acme/spring/web/GreetingControllerTest.java

   package org.acme.spring.web;
   
   import io.quarkus.test.junit.QuarkusTest;
   import org.junit.jupiter.api.Test;
   
   import static io.restassured.RestAssured.given;
   import static org.hamcrest.CoreMatchers.is;
   
   @QuarkusTest
   public class GreetingControllerTest {
   
       @Test
       public void testHelloEndpoint() {
           given()
             .when().get("/greeting")
             .then()
                .statusCode(200)
                .body(is("Hello Spring"));
       }
   
   }

   Copy to Clipboard Toggle word wrap

手順

1. プロジェクトのルートディレクトリーに移動します。

   cd <project_name>

   Copy to Clipboard Toggle word wrap

2. Quarkus Maven プラグインを使用して、開発モードでアプリケーションを実行します。

   ./mvnw compile quarkus:dev

   Copy to Clipboard Toggle word wrap

3. http://localhost:8080/greeting に移動します。以下のメッセージがブラウザーに表示されます。

   Hello Spring

   Copy to Clipboard Toggle word wrap

手順

1. 以下の例のように、GreetingController クラスを展開します。拡張されたクラスは、greeting および名前が含まれる JSON 形式のレスポンスを返します。Spring Web から PathVariable アノテーションクラスをインポートして、設定が正しく機能することを確認する必要があります。

   src/main/java/org/acme/spring/web/GreetingController.java

   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.PathVariable;
   import org.springframework.web.bind.annotation.RequestMapping;
   import org.springframework.web.bind.annotation.RestController;
   
   @RestController
   @RequestMapping("/greeting")
   public class GreetingController {
   
       @GetMapping
       public String hello() {
           return "hello";
       }
   
       @GetMapping("/{name}")
       public Greeting hello(@PathVariable(name = "name") String name) {
           return new Greeting("hello " + name);
       }
   
       public static class Greeting {
           private final String message;
   
           public Greeting(String message) {
               this.message = message;
           }
   
           public String getMessage(){
               return message;
           }
       }
   }

   Copy to Clipboard Toggle word wrap

1. REST エンドポイントに変更を加える場合、REST エンドポイントのユニットテストが含まれるクラスファイルも更新する必要があります。

   src/test/java/org/acme/spring/web/GreetingControllerTest.java

   package org.acme.spring.web;
   
   import io.quarkus.test.junit.QuarkusTest;
   import org.junit.jupiter.api.Test;
   
   import static io.restassured.RestAssured.given;
   import static org.hamcrest.CoreMatchers.is;
   
   @QuarkusTest
   public class GreetingControllerTest {
   
       @Test
       public void testHelloEndpoint() {
           given()
             .when().get("/greeting/quarkus")
             .then()
               .statusCode(200)
               .body("message", is("hello quarkus"));
       }
   
   }

   Copy to Clipboard Toggle word wrap

   Quarkus で Spring Web 互換レイヤーを使用すると、com.fasterxml:jackson.core 依存関係がアプリケーションのクラスパスに自動的に追加されて設定される点に留意してください。

手順

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

手順

1. @OpenApiDefinition アノテーションを GreetingController のクラスレベルに追加します。アノテーションの例に示されているデータを含めます。

   @OpenAPIDefinition(
       info = @Info(
           title="Greeting API",
           version = "1.0.1",
           contact = @Contact(
               name = "Greeting API Support",
               url = "http://exampleurl.com/contact",
               email = "techsupport@example.com"),
           license = @License(
               name = "Apache 2.0",
               url = "https://www.apache.org/licenses/LICENSE-2.0.html"))
   )

   Copy to Clipboard Toggle word wrap

2. @Tag アノテーションを使用してエンドポイント定義にアノテーションを付けます。エンドポイントごとに名前と説明を指定します。

   @Tag(name = "Hello", description = "Just say hello")
   @GetMapping(produces=MediaType.TEXT_PLAIN_VALUE)
   public String hello() {
       return "hello";
   }
   
   @GetMapping(value = "/{name}", produces=MediaType.APPLICATION_JSON_VALUE)
   @Tag(name = "Hello to someone", description = "Just say hello to someone")
   public Greeting hello(@PathVariable(name = "name") String name) {
       return new Greeting("hello " + name);
   }

   Copy to Clipboard Toggle word wrap

   アノテーションで指定したデータは、生成された OpenAPI スキーマに表示されます。

   openapi: 3.0.3
   info:
     title: Greeting API
     contact:
       name: Greeting API Support
       url: http://exampleurl.com/contact
       email: techsupport@example.com
     license:
       name: Apache 2.0
       url: https://www.apache.org/licenses/LICENSE-2.0.html
     version: 1.0.1
   tags:
   - name: Hello
       description: Just say hello
   - name: Hello to someone
       description: Just say hello to someone
   paths:
     /greeting:
       get:
         tags:
         - Hello
         responses:
           '200':
             description: OK
             content:
               text/plain:
                 schema:
                   type: string
     /greeting/{name}:
       get:
         tags:
         - Hello to someone
         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