feat: add graphql service (#11)

Co-authored-by: rick <LinuxSuRen@users.noreply.github.com>

Author: LinuxSuRen

.gitpod.yml

@@ -5,3 +5,4 @@ vscode:
   extensions:
     - linuxsuren.api-testing
     - vscjava.vscode-maven
+    - redhat.java

README.md

@@ -7,6 +7,9 @@ Run E2E testing:
 make build-image test-e2e
 ```
 
+## GraphQL
+You can visit it via: http://localhost:8080/graphiql?path=/graphql
+
 ## OpenAPI
 You can visit the swagger UI with the following address:
 

e2e/test-suite.yaml

@@ -30,3 +30,33 @@ items:
       Authorization: Basic YWRtaW46MTIzNDU2
   expect:
     body: cookies are empty
+
+## GraphQL
+- name: queryBookById
+  request:
+    api: /graphql
+    method: POST
+    header:
+      Content-Type: application/json
+    body: |
+      {
+        "query": "query xxx {\n  bookById(id: \"book-1\") {\n    id\n    name\n  }\n}",
+        "operationName": "xxx"
+      }
+  expect:
+    bodyFieldsExpect:
+      data.bookById.name: Effective Java
+- name: queryBookById-not-found
+  request:
+    api: /graphql
+    method: POST
+    header:
+      Content-Type: application/json
+    body: |
+      {
+        "query": "query xxx {\n  bookById(id: \"book\") {\n    id\n    name\n  }\n}",
+        "operationName": "xxx"
+      }
+  expect:
+    verify:
+      - data.bookById == nil

pom.xml

@@ -27,6 +27,11 @@
 			<artifactId>spring-boot-starter-security</artifactId>
 		</dependency>
 
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-graphql</artifactId>
+		</dependency>
+
 		<dependency>
 			<groupId>org.springdoc</groupId>
 			<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>

src/main/java/io/github/devopsws/demo/config/WebSecurityConfig.java

@@ -9,16 +9,22 @@
 import org.springframework.security.core.userdetails.UserDetailsService;
 import org.springframework.security.provisioning.InMemoryUserDetailsManager;
 import org.springframework.security.web.SecurityFilterChain;
+import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
+import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
+import static org.springframework.security.config.Customizer.withDefaults;
 
 @Configuration
 @EnableWebSecurity
+// @EnableGlobalMethodSecurity(prePostEnabled = true, securedEnabled = true)
 public class WebSecurityConfig {
 
     @Bean
     public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
         http.authorizeHttpRequests((requests) -> requests
-                .requestMatchers("/health", "/v3/api-docs").permitAll()
-                .anyRequest().authenticated()).httpBasic();
+                .requestMatchers("/health", "/v3/api-docs", "/graphql", "/graphiql").permitAll()
+                .anyRequest().authenticated())
+                .httpBasic(withDefaults())
+                .csrf(AbstractHttpConfigurer::disable);
 
         return http.build();
     }

src/main/java/io/github/devopsws/demo/model/Author.java

@@ -0,0 +1,20 @@
+package io.github.devopsws.demo.model;
+
+import java.util.Arrays;
+import java.util.List;
+
+public record Author (String id, String firstName, String lastName) {
+
+    private static List<Author> authors = Arrays.asList(
+            new Author("author-1", "Joshua", "Bloch"),
+            new Author("author-2", "Douglas", "Adams"),
+            new Author("author-3", "Bill", "Bryson")
+    );
+
+    public static Author getById(String id) {
+        return authors.stream()
+				.filter(author -> author.id().equals(id))
+				.findFirst()
+				.orElse(null);
+    }
+}

src/main/java/io/github/devopsws/demo/model/Book.java

@@ -0,0 +1,20 @@
+package io.github.devopsws.demo.model;
+
+import java.util.Arrays;
+import java.util.List;
+
+public record Book (String id, String name, int pageCount, String authorId) {
+
+    private static List<Book> books = Arrays.asList(
+            new Book("book-1", "Effective Java", 416, "author-1"),
+            new Book("book-2", "Hitchhiker's Guide to the Galaxy", 208, "author-2"),
+            new Book("book-3", "Down Under", 436, "author-3")
+    );
+
+    public static Book getById(String id) {
+        return books.stream()
+				.filter(book -> book.id().equals(id))
+				.findFirst()
+				.orElse(null);
+    }
+}

src/main/java/io/github/devopsws/demo/service/GraphQL.java

@@ -0,0 +1,19 @@
+package io.github.devopsws.demo.service;
+
+import org.springframework.graphql.data.method.annotation.Argument;
+import org.springframework.graphql.data.method.annotation.QueryMapping;
+import org.springframework.graphql.data.method.annotation.SchemaMapping;
+import org.springframework.stereotype.Controller;
+import io.github.devopsws.demo.model.Book;
+import org.springframework.security.access.annotation.Secured;
+import org.springframework.security.access.prepost.PreAuthorize;
+
+@Controller
+public class GraphQL {
+    @QueryMapping
+    // @Secured("ROLE_USER")
+    // @PreAuthorize("hasRole('USER')")
+    public Book bookById(@Argument String id) {
+        return Book.getById(id);
+    }
+}

src/main/resources/application.properties

@@ -1 +1,2 @@
-
+# https://spring.io/guides/gs/graphql-server/
+spring.graphql.graphiql.enabled=true

src/main/resources/graphql/schema.graphqls

@@ -0,0 +1,16 @@
+type Query {
+    bookById(id: ID): Book
+}
+
+type Book {
+    id: ID
+    name: String
+    pageCount: Int
+    author: Author
+}
+
+type Author {
+    id: ID
+    firstName: String
+    lastName: String
+}