Quarkus를 사용한 GraphQL API

API용 쿼리 언어

이 기사에서는 Quarkus GraphQL 지원을 보여드리겠습니다. 예를 들어 이전 기사의 Superheroes 응용 프로그램을 사용합니다. 몇 가지 GraphQL 주제에 대해 논의할 것입니다.

코드, 종속성 및 모델

이 앱의 소스 코드는 Github 에 있습니다. 원하는 경우 예제를 직접 시도할 수 있습니다. 종속성으로 예를 들어 포함했습니다. SmallRye GraphQL 및 롬복. 여기서 pom.xml 파일을 자세히 볼 수 있습니다.

Quarkus는 GraphQL API를 생성하는 데 도움이 됩니다. GraphQL 스키마가 생성됩니다. 모델을 정의하기만 하면 됩니다. 여기에서는 Superhero 데이터 전송 개체의 예를 보여 드리겠습니다. DTO를 사용하여 API에서 데이터를 노출합니다. Lombok@Data은 getter, setter, toString, equals 및 hashCode 메서드를 처리합니다.

import lombok.Data;

@Data
@FieldDefaults(level = AccessLevel.PRIVATE, makeFinal = true)
public class Superhero {

    String name;
    City city;

}

데이터를 가져 오는 중

모든 도시를 쿼리하려면 이와 같은 명령을 GraphiQL UIhttp://localhost:8080/q/graphql-ui/에 보내면 됩니다.

{
    allCities {
        name
    }
}

그리고 GraphQL을 사용하면 개체 그래프를 가져오기가 매우 쉽습니다. 예를 들어, 이와 같이 슈퍼히어로가 있는 도시를 쿼리할 수 있습니다.

query getCity {
     city(cityId: 0) {
         name
         symbol
         superheroes {
             name
         }
     }
 }

서버 측 리졸버 및 돌연변이

확인자는 쿼리 정의를 담당합니다. 모든 쿼리는 SuperheroResolver 에 있습니다.

@GraphQLApi
public class SuperheroResolver {

    @Inject
    SuperheroService superheroService;

    @Query("allCities")
    @Description("Get all cities.")
    public List<City> getAllCities() {
        return superheroService.getAllCities();
    }
 ...
}

쿼리에서 돌연변이를 분리했습니다. 돌연변이는 생성, 업데이트 또는 삭제와 같은 쓰기 작업입니다. 여기에서는 SuperheroInput을 입력 개체로 사용하여 SuperheroMutation의 create() 메서드를 보여줍니다.

@GraphQLApi
public class SuperheroMutation {

    @Inject
    SuperheroService superheroService;

    @Mutation
    public Superhero createSuperhero(@Name("superhero") SuperheroInput superheroInput) {
        var superhero = new Superhero(superheroInput.getName(), superheroInput.getCity());
        superheroService.addSuperhero(superhero);
        return superhero;
    }
...
}

GraphQL API 테스트

Quarkus가 소스 코드를 기반으로 GraphQL 스키마를 자동으로 생성한다는 것은 정말 멋진 일입니다. 스키마를 표시하려면 http://localhost:8080/graphql/schema.graphql 을 호출하면 됩니다. 여기에서는 자동화된 테스트를 작성하는 방법을 빠르게 보여드리고자 합니다. GraphQL API를 어떻게 테스트합니까? 여기 Rest-Assured가 구출됩니다. REST에서 이미 알고 있는 방식으로 테스트를 작성할 수 있습니다.

@QuarkusTest
public class SuperheroTest {

    @Test
    void allCities() {
        final Response response = given()
                .contentType(ContentType.JSON)
                .body("{\"query\":\"{\\n allCities{\\n name\\n}\\n}\"}")
                .when()
                .post("/graphql")
                .then()
                    .assertThat()
                    .statusCode(200)
                .and()
                    .extract()
                    .response();

        final List<City> allCities = response.jsonPath().getList("data.allCities", City.class);
        assertThat(allCities)
                .isNotEmpty()
                .hasSize(2)
                .extracting(City::getName)
                .contains("Gotham City", "New York City");
    }

}

결론

저는 Quarkus의 GraphQL 지원을 좋아합니다. GraphQL 스키마가 코드와 주석을 통해 자동으로 생성된다는 점이 좋습니다. 다음 파트에서는 ​​컬, GraphiQL 도구 및 불면증으로 GraphQL API를 테스트하는 방법을 보여 드리겠습니다.

Raphaël Biscaldi에 Unsplash의 사진

연결
https://github.com/claudioaltamura/quarkus-graphql-superheroes

https://quarkus.io/guides/smallrye-graphql

https://rest-assured.io/