diff --git a/samples/README.md b/samples/README.md index 5647e427..a95adca6 100644 --- a/samples/README.md +++ b/samples/README.md @@ -1,11 +1,11 @@ -This directory contains samples that we run to test different scenarios and features. +**Samples Directory** -All samples use the Boot starter and expose a GraphiQL page where you can run queries. Simply start the `main` application class and go to http://localhost:8080/graphiql. +This directory contains samples we test scenarios and features with. + +All samples use the Boot starter, have integration tests you can run or debug, and expose a GraphiQL page to try queries with. Simply start the `main` application class and go to http://localhost:8080/graphiql. To run from the command line, use: ```shell script $ ./gradlew :samples:{sample-directory-name}:bootRun ``` -Samples have integration tests you can run with a debugger. - diff --git a/samples/webflux-security/README.md b/samples/webflux-security/README.md index e05c5cbe..9c9ee12e 100644 --- a/samples/webflux-security/README.md +++ b/samples/webflux-security/README.md @@ -1,6 +1,4 @@ -Sample with Spring Security in a WebFlux application. - -Main features: +**Spring Security for GraphQL HTTP Endpoint with WebFlux** - Spring Security [config](src/main/java/io/spring/sample/graphql/SecurityConfig.java) secures GraphQL HTTP endpoint. - Fine-grained, method-level security on [SalaryService](src/main/java/io/spring/sample/graphql/SalaryService.java). diff --git a/samples/webflux-websocket/README.md b/samples/webflux-websocket/README.md index db07dd5f..c07548dc 100644 --- a/samples/webflux-websocket/README.md +++ b/samples/webflux-websocket/README.md @@ -1,7 +1,5 @@ -Sample with GraphQL over WebSocket in a WebFlux application. +**GraphQL WebSocket Endpoint with Spring WebFlux** -Main features: - - - Reactive [DataFetcher's](src/main/java/io/spring/sample/graphql/SampleWiring.java), including subscription stream. - - [WebFilter](src/main/java/io/spring/sample/graphql/ContextWebFilter.java) that inserts Reactor `Context` that is then accessed in the [DataRepository](src/main/java/io/spring/sample/graphql/DataRepository.java). - - [Tests](src/test/java/io/spring/sample/graphql/SubscriptionTests.java) for subscription streams. \ No newline at end of file + - Reactive [DataFetcher's](src/main/java/io/spring/sample/graphql/SampleWiring.java), for queries and subscriptions. + - [WebFilter](src/main/java/io/spring/sample/graphql/ContextWebFilter.java) to insert Reactor `Context` and check it can be accessed in [DataRepository](src/main/java/io/spring/sample/graphql/DataRepository.java). + - Subscription [tests](src/test/java/io/spring/sample/graphql/SubscriptionTests.java) using Reactor's `StepVerifier` to verify the stream. \ No newline at end of file diff --git a/samples/webmvc-http-security/README.md b/samples/webmvc-http-security/README.md index 0b57f437..677eff76 100644 --- a/samples/webmvc-http-security/README.md +++ b/samples/webmvc-http-security/README.md @@ -1,6 +1,4 @@ -Sample with Spring Security in a Spring MVC application. - -Main features: +**Spring Security for GraphQL HTTP Endpoint with Spring MVC** - Spring Security [config](src/main/java/io/spring/sample/graphql/SecurityConfig.java) secures GraphQL HTTP endpoint. - Fine-grained, method-level security on [SalaryService](src/main/java/io/spring/sample/graphql/SalaryService.java). diff --git a/samples/webmvc-http/README.md b/samples/webmvc-http/README.md index 69b3a608..0e285883 100644 --- a/samples/webmvc-http/README.md +++ b/samples/webmvc-http/README.md @@ -1,6 +1,4 @@ -Sample with a GraphQL HTTP endpoint in Spring MVC. - -Main features: +**GraphQL HTTP Endpoint with Spring MVC** - Spring HATEOAS [DataFetcher's](src/main/java/io/spring/sample/graphql/project/ProjectDataWiring.java) that call spring.io REST API. - Querydsl [DataFetcher's](src/main/java/io/spring/sample/graphql/repository/ArtifactRepositoryDataWiring.java) making JPA queries.