Add POST verb to create a greeting (beside GET verb)

Author: debuglevel

README.md

@@ -23,12 +23,6 @@ Analyses have to be POSTed first to the microservice before you can GET their re
 
 ## Swagger / OpenAPI
 There is an OpenAPI (former: Swagger) specification created, which is available at <http://localhost:8080/swagger/greeter-microservice-0.1.0.yml> (or somewhere in the jar file). It can easily be pasted into the [Swagger Editor](https://editor.swagger.io) which provides a live demo for [Swagger UI](https://swagger.io/tools/swagger-ui/), but also offers to create client libraries via [Swagger Codegen](https://swagger.io/tools/swagger-codegen/).
- 
-## Add greeting
-Actually, there is no POST endpoint in this simple example. But if there was one, a POST request could be sent like this:
-```
-$ curl -X POST -d @upload.json -H "Content-Type: application/json" -H "Accept: application/json" http://localhost/greetings/
-```
 
 ## Get greeting
 To get an appropriate greeting for a person, send a GET request to the service:
@@ -47,5 +41,11 @@ $ curl -X GET -H "Content-Type: application/json" -H "Accept: application/json"
 }
 ```
 
+## Add greeting
+In this example, a greeting can also be POSTed. This way, the payload is transferred in the body as JSON (which is often a better idea than putting it in the URL or parameters, due to URL encoding issues).
+```
+$ curl -X POST -d '{"name":"Max", "language":"de_DE"}' -H "Content-Type: application/json" -H "Accept: application/json" http://localhost/greetings/
+```
+
 # Configuration
 There is a `application.yml` included in the jar file. Its content can be modified and saved as a separate `application.yml` on the level of the jar file. Configuration can also be applied via the other supported ways of Micronaut (see <https://docs.micronaut.io/latest/guide/index.html#config>). For Docker, the configuration via environment variables is the most interesting one (see `docker-compose.yml`).

src/main/kotlin/de/debuglevel/greeter/greeting/GreetingController.kt

@@ -2,6 +2,7 @@ package de.debuglevel.greeter.greeting
 
 import io.micronaut.http.annotation.Controller
 import io.micronaut.http.annotation.Get
+import io.micronaut.http.annotation.Post
 import io.micronaut.security.annotation.Secured
 import io.micronaut.security.rules.SecurityRule
 import mu.KotlinLogging
@@ -27,6 +28,16 @@ class GreetingController(private val greetingService: GreetingService) {
         return greetingService.greet(name, language)
     }
 
+    /**
+     * Get a greeting for a person. If given, the greeting is localized in a language.
+     * @return A greeting for a person in a given language
+     */
+    @Post("/")
+    fun postOne(greetingRequest: GreetingRequest): Greeting {
+        logger.debug("Called postOne($greetingRequest)")
+        return greetingService.greet(greetingRequest.name, greetingRequest.language)
+    }
+
     /**
      * Gets some greetings.
      * @return Some greetings

src/main/kotlin/de/debuglevel/greeter/greeting/GreetingRequest.kt

@@ -0,0 +1,6 @@
+package de.debuglevel.greeter.greeting
+
+data class GreetingRequest(
+    val name: String,
+    val language: String?
+)

src/test/kotlin/de/debuglevel/greeter/greeting/GreetingClient.kt

@@ -1,6 +1,7 @@
 package de.debuglevel.greeter.greeting
 
 import io.micronaut.http.annotation.Get
+import io.micronaut.http.annotation.Post
 import io.micronaut.http.client.annotation.Client
 import io.reactivex.Single
 import javax.validation.constraints.NotBlank
@@ -11,6 +12,9 @@ interface GreetingClient {
     @Get("/{name}{?language}")
     fun getOne(@NotBlank name: String, language: String?): Single<GreetingDTO>
 
+    @Post("/")
+    fun postOne(greetingRequest: GreetingRequest): Single<GreetingDTO>
+
 //    @Get
 //    fun getList(): Set<GreetingDTO>
 }

src/test/kotlin/de/debuglevel/greeter/greeting/GreetingClientTests.kt

@@ -16,7 +16,7 @@ class GreetingClientTests {
 
     @ParameterizedTest
     @MethodSource("validNameAndLanguageProvider")
-    fun `greet valid names in various languages`(testData: TestDataProvider.NameTestData) {
+    fun `greet valid names in various languages (GET)`(testData: TestDataProvider.NameTestData) {
         // Arrange
 
         // Act
@@ -26,6 +26,19 @@ class GreetingClientTests {
         Assertions.assertThat(greeting.greeting).isEqualTo(testData.expected)
     }
 
+    @ParameterizedTest
+    @MethodSource("validNameAndLanguageProvider")
+    fun `greet valid names in various languages (POST)`(testData: TestDataProvider.NameTestData) {
+        // Arrange
+        val greetingRequest = GreetingRequest(testData.name, testData.language)
+
+        // Act
+        val greeting = greetingClient.postOne(greetingRequest).blockingGet()
+
+        // Assert
+        Assertions.assertThat(greeting.greeting).isEqualTo(testData.expected)
+    }
+
     fun validNameAndLanguageProvider() = TestDataProvider.validNameAndLanguageProvider()
 
     // do not test "invalid" names (i.e. "" and " ") as their HTTP call would translate to "/greetings/" which then returns the getList() stuff

src/test/kotlin/de/debuglevel/greeter/greeting/GreetingControllerTests.kt

@@ -1,5 +1,6 @@
 package de.debuglevel.greeter.greeting
 
+import io.micronaut.http.HttpRequest
 import io.micronaut.http.client.HttpClient
 import io.micronaut.http.client.annotation.Client
 import io.micronaut.http.uri.UriBuilder
@@ -23,7 +24,7 @@ class GreetingControllerTests {
 
     @ParameterizedTest
     @MethodSource("validNameAndLanguageProvider")
-    fun `greet valid names in various languages`(testData: TestDataProvider.NameTestData) {
+    fun `greet valid names in various languages (GET)`(testData: TestDataProvider.NameTestData) {
         // Arrange
 
         // Act
@@ -38,6 +39,21 @@ class GreetingControllerTests {
         Assertions.assertThat(greeting).contains(testData.expected)
     }
 
+    @ParameterizedTest
+    @MethodSource("validNameAndLanguageProvider")
+    fun `greet valid names in various languages (POST)`(testData: TestDataProvider.NameTestData) {
+        // Arrange
+        val greetingRequest = GreetingRequest(testData.name, testData.language)
+
+        // Act
+        val uri = UriBuilder.of("/").build()
+        val greeting = httpClient.toBlocking()
+            .retrieve(HttpRequest.POST(uri, greetingRequest), GreetingDTO::class.java)
+
+        // Assert
+        Assertions.assertThat(greeting.greeting).isEqualTo(testData.expected)
+    }
+
     fun validNameAndLanguageProvider() = TestDataProvider.validNameAndLanguageProvider()
 
     // do not test "invalid" names (i.e. "" and " ") as their HTTP call would translate to "/greetings/" which then returns the getList() stuff