updated to renamed openapi-processor

Author: hauner

README.md

@@ -1,9 +1,13 @@
-# openapi-generatr-spring sample project
+# openapi-processor-spring sample project
 
-This is a simple Spring Boot project that is using the [openapi-generatr-spring][generatr-spring] to
-generate java interfaces for the api defined in an openapi.yaml file.
+This is a simple Spring Boot project that is using 
+* [openapi-processor-spring][oap-spring] to
+generate java interfaces for the api defined in an openapi.yaml file and
+* the [openapi-processor-json][oap-json] to convert the openapi yaml to json format. 
 
-The sample is based on gradle and uses the [generatr-gradle plugin][generatr-gradle].
 
-[generatr-spring]: https://hauner.github.io/openapi-generatr-spring/
-[generatr-gradle]: https://github.com/hauner/openapi-generatr-gradle
+The sample is based on gradle and uses the [openapi-processor-gradle plugin][oap-gradle].
+
+[oap-spring]: https://hauner.github.io/openapi-processor-spring/
+[oap-json]: https://hauner.github.io/openapi-processor-json/
+[oap-gradle]: https://github.com/hauner/openapi-processor-gradle

build.gradle

@@ -5,8 +5,8 @@ plugins {
     id 'org.springframework.boot' version '2.1.7.RELEASE'
     id 'org.unbroken-dome.test-sets' version '2.1.1'
 
-    // add generatr-gradle plugin
-    id 'com.github.hauner.openapi-generatr' version '1.0.0.M5'
+    // add processor-gradle plugin
+    id 'com.github.hauner.openapi-processor' version '1.0.0.M7'
 }
 
 group = 'com.github.hauner'
@@ -29,22 +29,22 @@ dependencies {
 }
 
 
-// configure an openapi-generatr inside the 'openapiGeneratr' configuration by adding a nested
-// configuration with the name of the generatr and its options inside it.
+// configure an openapi-processor inside the 'openapiProcessor' configuration by adding a nested
+// configuration with the name of the openapi-processor and its options inside it.
 //
 // ... using 'spring' and 'json'.
-openapiGeneratr {
+openapiProcessor {
 
-    // the path to the open api yaml file. Usually the same for all generatrs.
+    // the path to the open api yaml file. Usually the same for all processors.
     apiPath "${projectDir}/src/api/openapi.yaml"
 
-    // based on the name of a generatr configuration the plugin creates a gradle task with name
-    // "generate${name of generator}"  (in this case "generateSpring") to run the generatr.
+    // based on the name of the processor configuration the plugin creates a gradle task with name
+    // "process${name of processor}"  (in this case "processSpring") to run the processor.
     spring {
-        // the spring generatr dependency
-        generatr 'com.github.hauner.openapi:openapi-generatr-spring:1.0.0.M7'
+        // the spring processor dependency
+        processor 'com.github.hauner.openapi:openapi-processor-spring:1.0.0.M9'
 
-        // setting api path inside a generatr configuration override the one at the top.
+        // setting api path inside a processor configuration overrides the one at the top.
         // apiPath "${projectDir}/src/api/openapi.yaml"
 
         // the destination folder for generating interfaces & models. This is the parent of the
@@ -53,23 +53,23 @@ openapiGeneratr {
 
         // file name of the mapping yaml configuration file. Note that the yaml file name must end
         // with either {@code .yaml} or {@code .yml}.
-        mapping "$projectDir/openapi-generatr-spring.yaml"
+        mapping "${projectDir}/src/api/mapping.yaml"
 
         // show warnings from the open api parser.
         showWarnings true
     }
 
-    // applying the rule described above the task to run this one is "generateJson".
+    // applying the rules described above the task to run this one is "processJson".
     json {
-        // the json generatr dependency
-        generatr 'com.github.hauner.openapi:openapi-generatr-json:1.0.0.M2'
+        // the json processor dependency
+        processor 'com.github.hauner.openapi:openapi-processor-json:1.0.0.M3'
 
         targetDir "$buildDir/json"
     }
 
 }
 
-// add the targetDir of the generatr as additional source folder to java.
+// add the targetDir of the processor as additional source folder to java.
 sourceSets {
     main {
         java {
@@ -84,7 +84,7 @@ sourceSets {
 }
 
 // generate api before compiling
-compileJava.dependsOn ('generateSpring')
-processResources.dependsOn ('generateJson')
+compileJava.dependsOn ('processSpring')
+processResources.dependsOn ('processJson')
 
 check.dependsOn testInt

settings.gradle

@@ -1,5 +1,5 @@
-rootProject.name = 'openapi-generatr-spring-mvc-sample'
+rootProject.name = 'openapi-processor-spring-mvc-sample'
 
-//includeBuild '../openapi-generatr-gradle'
-//includeBuild '../openapi-generatr-spring'
-//includeBuild '../openapi-generatr-json'
+//includeBuild '../openapi-processor-gradle'
+//includeBuild '../openapi-processor-spring'
+//includeBuild '../openapi-processor-json'

openapi-generatr-spring.yaml renamed to src/api/mapping.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.2
 info:
-  title: sample api for openapi-generatr-spring
+  title: openapi-processor-spring sample api
   version: 1.0.0
 
 paths: