improved sample (additional endpoint, tests)

Author: hauner

build.gradle

@@ -1,19 +1,25 @@
 buildscript {
-  dependencies {
-    // add generatr-spring
-    classpath "com.github.hauner.openapi:openapi-generatr-spring"
-  }
+    repositories {
+        maven {
+            url "https://dl.bintray.com/hauner/openapi-generatr"
+        }
+    }
+
+    dependencies {
+        // add generatr-spring
+        classpath "com.github.hauner.openapi:openapi-generatr-spring"
+    }
 }
 
 plugins {
     id 'org.springframework.boot' version '2.1.7.RELEASE'
     id 'io.spring.dependency-management' version '1.0.8.RELEASE'
     id 'java'
+    id 'groovy'
+    id 'org.unbroken-dome.test-sets' version '2.1.1'
 
     // add generatr-gradle plugin
-    // note: currently this works only inside the openapi-generatr-dev project because the
-    // plugin is not yet published to https://plugins.gradle.org/
-    id 'com.github.hauner.openapi.openapiGeneratr' version '0.1-SNAPSHOT'
+    id 'com.github.hauner.openapi-generatr' version '1.0.0.B2'
 }
 
 group = 'com.github.hauner'
@@ -24,13 +30,21 @@ repositories {
     mavenCentral ()
 }
 
+testSets {
+    testInt
+}
+
+check.dependsOn testInt
+
 dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-web'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
+    testImplementation 'org.spockframework:spock-core:1.3-groovy-2.5'
+    testImplementation 'org.spockframework:spock-spring:1.3-groovy-2.5'
 }
 
 // options of openapi-generatr-spring, this maps directly on the options class of the generatr.
-// In this case: com.github.hauner.openapi.spring.generatr.ApiOptions
+// In this case: com.github.hauner.openapi.spring.generatr.SpringGeneratrOptions
 generatrSpring {
     // the path to the open api yaml file.
     apiPath = "$projectDir/src/api/openapi.yaml"
@@ -39,6 +53,10 @@ generatrSpring {
     // {packageName} folder tree.
     targetDir = "$projectDir/build/openapi"
 
+     // either a type mapping yaml as string or a file name to a type mapping yaml. Note that the yaml
+     // file name must end with either {@code .yaml} or {@code .yml}.
+     // typeMappings = "$projectDir/mapping.yaml"
+
     // the root package of the generated interfaces/model. The package folder tree will be created
     // inside {targetDir}. Interfaces and models will be placed into the "api" and "model"
     // subpackages of packageName:
@@ -60,4 +78,4 @@ sourceSets {
 }
 
 // generate api before compiling
-classes.dependsOn ('generateSpringApi')
+compileJava.dependsOn ('generateSpring')

src/api/openapi.yaml

@@ -5,16 +5,36 @@ info:
 
 paths:
   /ping:
-
     get:
       tags:
         - ping
       summary: returns a single "pong" string.
       description: very simple sample endpoint
       responses:
         '200':
+          description: pong
+          content:
+            text/plain:
+              schema:
+                type: string
+
+  /echo:
+    get:
+      tags:
+        - echo
+      summary: echos the given parameter string.
+      description: sample endpoint with parameter
+      parameters:
+        - name: source
+          description: query, required, string
+          in: query
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: echo of the source parameter
           content:
             text/plain:
               schema:
                 type: string
-          description: "pong"

src/main/java/com/github/hauner/openapi/EchoController.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2019 the original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.github.hauner.openapi;
+
+import com.github.hauner.openapi.api.EchoApi;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+
+/**
+ * Implementation of the echo api defined in src/api/openapi.yaml.
+ *
+ * @author Martin Hauner
+ */
+@Controller
+public class EchoController implements EchoApi {
+
+    @Override
+    public ResponseEntity<String> getEcho (String source) {
+        return ResponseEntity.ok (source);
+    }
+
+}

src/main/java/com/github/hauner/openapi/PingController.java

@@ -21,7 +21,7 @@
 import org.springframework.stereotype.Controller;
 
 /**
- * Implementation of the api defined in src/api/openapi.yaml.
+ * Implementation of the ping api defined in src/api/openapi.yaml.
  *
  * @author Martin Hauner
  */

src/test/java/com/github/hauner/openapi/SpringMvcSampleApplicationTests.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2019 the original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.github.hauner.openapi
+
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.boot.test.web.client.TestRestTemplate
+import org.springframework.http.HttpEntity
+import org.springframework.http.HttpHeaders
+import org.springframework.http.HttpMethod
+import org.springframework.http.MediaType
+import org.springframework.web.util.UriComponentsBuilder
+import spock.lang.Specification
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+class EchoControllerSpec extends Specification {
+
+    @Autowired
+    TestRestTemplate restTemplate
+
+    void "echo returns 'pong'" () {
+        def headers = new HttpHeaders()
+        headers.setAccept ([MediaType.TEXT_PLAIN])
+
+        def entity = new HttpEntity(headers)
+
+        def uri = UriComponentsBuilder.fromUriString ('/echo')
+            .queryParam ('source', 'pong')
+            .build ()
+            .toUri ()
+
+        expect:
+        restTemplate.exchange (uri, HttpMethod.GET, entity, String).body == 'pong'
+    }
+
+}

src/testInt/groovy/com/github/hauner/openapi/EchoControllerSpec.groovy

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2019 the original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.github.hauner.openapi
+
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.boot.test.web.client.TestRestTemplate
+import spock.lang.Specification
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+class PingControllerSpec extends Specification {
+
+    @Autowired
+    TestRestTemplate restTemplate
+
+    void "ping returns pong" () {
+        expect:
+        restTemplate.getForEntity ('/ping', String).body == 'pong'
+    }
+
+}