final commit for blog post

Author: danielkocot

README.md

@@ -1,5 +1,27 @@
-# API first Spring Boot Service (WIP)
 
-This Spring Boot Service will be created by the API first approach and tested with [Karate](https://intuit.github.io/karate/). Due to missing capability of OpenAPI Generator in Version 5.0.0 the direct download of the API spec is not possible at the moment. So we will rely on using [Gradle Download Task](https://github.com/michel-kraemer/gradle-download-task). There is also already a [bug report](https://github.com/OpenAPITools/openapi-generator/issues/8255) written by [joschi](https://github.com/joschi). And there is an open [feature request](https://github.com/OpenAPITools/openapi-generator/issues/9083) for OpenAPI Generator to support OpenAPI Spec 3.1 
+# OpenAPI generated API stub
 
-At the moment the blog post can be finalized with the workaround in mind. Also a good idea to test the "update feature" on the codecentric blog next year.
+Spring Framework stub
+
+
+## Overview
+This code was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
+By using the [OpenAPI-Spec](https://openapis.org), you can easily generate an API stub.
+This is an example of building API stub interfaces in Java using the Spring framework.
+
+The stubs generated can be used in your existing Spring-MVC or Spring-Boot application to create controller endpoints
+by adding ```@Controller``` classes that implement the interface. Eg:
+```java
+@Controller
+public class PetController implements PetApi {
+// implement all PetApi methods
+}
+```
+
+You can also use the interface to create [Spring-Cloud Feign clients](http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign-inheritance).Eg:
+```java
+@FeignClient(name="pet", url="http://petstore.swagger.io/v2")
+public interface PetClient extends PetApi {
+
+}
+```

build.gradle

@@ -1,10 +1,9 @@
 plugins {
     id 'org.springframework.boot' version '2.3.5.RELEASE'
     id 'io.spring.dependency-management' version '1.0.10.RELEASE'
-    id 'org.openapi.generator' version '5.1.1'
     id 'de.undercouch.download' version '4.1.1'
-    id 'org.asciidoctor.convert' version '1.5.8'
     id 'org.jetbrains.gradle.plugin.idea-ext' version '0.5'
+    id 'io.openapiprocessor.openapi-processor' version '2021.3'
     id 'java'
 }
 
@@ -26,28 +25,19 @@ repositories {
     mavenCentral()
 }
 
-ext {
-    set('snippetsDir', file("build/generated-snippets"))
-}
 
 dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-actuator'
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
     implementation 'org.springframework.boot:spring-boot-starter-data-rest'
     implementation 'org.springframework.boot:spring-boot-starter-web'
-    implementation 'io.springfox:springfox-boot-starter:3.0.0'
-
-    compile 'io.springfox:springfox-swagger-ui:3.0.0'
-    //needed for OpenAPI code generation
-    compile "io.springfox:springfox-swagger2:3.0.0"
-    compile "org.openapitools:jackson-databind-nullable:0.1.0"
 
+    compileOnly "org.projectlombok:lombok"
+    annotationProcessor "org.projectlombok:lombok"
     developmentOnly 'org.springframework.boot:spring-boot-devtools'
     runtimeOnly 'com.h2database:h2'
 
-    testImplementation('org.springframework.boot:spring-boot-starter-test') {
-        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
-    }
+    testImplementation('org.springframework.boot:spring-boot-starter-test')
     testImplementation('org.junit.jupiter:junit-jupiter-api:5.4.2')
     testRuntime('org.junit.jupiter:junit-jupiter-engine:5.4.2')
     testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
@@ -59,46 +49,33 @@ dependencies {
 
 test {
     useJUnitPlatform()
-    systemProperty('karate.options', System.properties.getProperty('karate.options'))
-    systemProperty('karate.env', System.properties.getProperty('karate.env'))
-    outputs.upToDateWhen { false }
 }
 
 task downloadFile(type: Download) {
     src "https://raw.githubusercontent.com/codecentric/api-showcases/main/specs/news.yaml"
-    dest buildDir
+    dest "${projectDir}/src/api"
     onlyIfModified true
     useETag true
 }
 
-openApiValidate {
-    inputSpec = "$buildDir/news.yaml"
+openapiProcessor {
+    spring {
+        processor 'io.openapiprocessor:openapi-processor-spring:2021.4'
+        apiPath "$projectDir/src/api/news.yaml"
+        targetDir "$projectDir/build/openapi"
+        mapping "$projectDir/mapping.yaml"
+        showWarnings true
+    }
 }
 
-openApiGenerate {
-    generatorName = "spring"
-    library = "spring-boot"
-    inputSpec = "$buildDir/news.yaml"
-    configFile = "${projectDir}/openapi-generator-config.json"
-    outputDir = "${buildDir}/generated/open-api"
-    templateDir = "${projectDir}/src/main/resources/openapi-templates"
-}
-
-tasks.openApiGenerate.dependsOn tasks.downloadFile
-
-idea.project.settings {
-    taskTriggers {
-        beforeBuild tasks.openApiGenerate
-        beforeRebuild tasks.openApiGenerate
-        afterSync tasks.openApiGenerate
-        beforeSync tasks.openApiGenerate
-    }
+afterEvaluate {
+    tasks.processSpring.dependsOn(tasks.downloadFile)
 }
 
 sourceSets {
     main {
         java {
-            srcDir "${buildDir.absolutePath}/generated/open-api/src/main/java"
+            srcDir "build/openapi"
         }
     }
 
@@ -110,16 +87,9 @@ sourceSets {
     }
 }
 
-compileJava {
-    dependsOn tasks.openApiGenerate
-    source "${buildDir}/generated/open-api/src/main/java"
-}
+
+compileJava.dependsOn('processSpring')
 
 springBoot {
     mainClassName = "de.codecentric.apifirstspringboot.ApifirstSpringbootApplication"
 }
-
-asciidoctor {
-    inputs.dir snippetsDir
-    dependsOn test
-}

mapping.yaml

@@ -0,0 +1,11 @@
+openapi-processor-mapping: v2
+
+options:
+  package-name: de.codecentric.generated.news
+
+map:
+  result: org.springframework.http.ResponseEntity
+
+  types:
+    - type: array => java.util.List
+

openapi-generator-config.json

@@ -0,0 +1,76 @@
+openapi: 3.0.1
+servers:
+  - url: 'http://localhost:8080/api'
+info:
+  version: 1.0.0
+  title: News API
+  contact:
+    name: Daniel Kocot
+    url: 'http://www.codecentric.de'
+    email: [email protected]
+  license:
+    name: MIT
+    url: https://www.tldrelgal.com/mit
+  description: An API to provide news
+tags:
+  - name: news
+paths:
+  /news:
+    get:
+      description: gets latest news
+      operationId: getNews
+      tags:
+        - news
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ArticleList'
+              examples: {}
+components:
+  schemas:
+    ArticleList:
+      title: ArticleList
+      type: array
+      items:
+        $ref: '#/components/schemas/Article'
+    Article:
+      x-java-class-annotation:
+        - "@javax.persistence.Entity"
+      title: Article
+      description: A article is a part of a news.
+      type: object
+      properties:
+        id:
+          x-java-field-annotation:
+            - "@javax.persistence.Id"
+            - "@javax.persistence.GeneratedValue(strategy = javax.persistence.GenerationType.IDENTITY)"
+          type: integer
+        title:
+          type: string
+        date:
+          type: string
+          format: date
+        description:
+          type: string
+        imageUrl:
+          type: string
+      required:
+        - id
+        - title
+        - date
+        - description
+        - imageUrl
+  securitySchemes: {}
+  examples:
+    news:
+      value:
+        description: Example shared example
+        type: object
+        properties:
+          id:
+            type: string
+        required:
+          - id

src/api/news.yaml

@@ -1,29 +1,28 @@
 package de.codecentric.apifirstspringboot.controller;
 
+import de.codecentric.apifirstspringboot.repository.NewsRepository;
 import de.codecentric.apifirstspringboot.service.NewsService;
-import de.codecentric.news.api.model.Article;
-import org.springframework.http.HttpStatus;
+import de.codecentric.generated.news.api.NewsApi;
+import de.codecentric.generated.news.model.Article;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
-import springfox.documentation.oas.annotations.EnableOpenApi;
 
 import java.util.List;
 
-@EnableOpenApi
-@RequestMapping("/api")
-@Controller
-public class NewsController {
+import static de.codecentric.apifirstspringboot.mapper.ArticleModelMapper.toApi;
 
-    private final NewsService newsService;
+@Controller
+public class NewsController implements NewsApi {
 
-    public NewsController(NewsService newsService) {
-        this.newsService = newsService;
-    }
+    @Autowired
+    private NewsService newsService;
 
-    @GetMapping("/news")
+    @Override
     public ResponseEntity<List<Article>> getNews() {
-        return new ResponseEntity<>(this.newsService.getNews(), HttpStatus.OK);
+        List<de.codecentric.apifirstspringboot.entities.Article> allArticles = newsService.retrieveAllArticles();
+        return ResponseEntity.ok().body(toApi(allArticles));
     }
 }