antora docs

Author: hauner

build.gradle

@@ -55,6 +55,10 @@ openapiProcessor {
         // with either {@code .yaml} or {@code .yml}.
         mapping "${projectDir}/src/api/mapping.yaml"
 
+        // sets the parser to SWAGGER or OPENAPI4J. if not set SWAGGER is used.
+        // OPENAPI4J provides better validation.
+        parser 'OPENAPI4J'
+
         // show warnings from the open api parser.
         showWarnings true
     }

docs/antora.yml

@@ -0,0 +1,5 @@
+name: openapi-processor-spring-mvc-sample
+title: openapi-processor-spring-mvc-sample
+version: master
+nav:
+- modules/ROOT/nav.adoc

docs/modules/ROOT/nav.adoc

@@ -0,0 +1 @@
+* xref:index.adoc[Documentation]

docs/modules/ROOT/pages/index.adoc

@@ -0,0 +1,44 @@
+= OpenAPI Spring MVC Sample
+:page-layout: default
+:oap-spring: https://hauner.github.io/openapi-processor-spring
+:oap-spring-mvc-sample: https://hauner.github.io/openapi-processor-spring-mvc-sample
+:oap-json: https://hauner.github.io/openapi-processor-json
+:oap-gradle: https://github.com/hauner/openapi-processor-gradle
+
+//
+// content
+//
+
+This is a simple Spring Boot (gradle) project that is using
+
+* xref:openapi-processor-spring:ROOT:index.adoc[openapi-processor-spring] to
+generate java interfaces for the api defined in an openapi.yaml file
+* link:{oap-json}[openapi-processor-json] to convert the openapi yaml to json format
+* link:{oap-gradle}[openapi-processor-gradle] plugin to run both processors
+
+The purpose of the sample is to show the setup of the gradle plugin and the processors.
+
+== Running the sample
+
+Clone the project from link:{oap-spring-mvc-sample}[GitHub], navigate into the project root folder
+and run
+
+----
+ ./gradlew bootRun
+----
+
+to start the sample application.
+
+
+== Sample Endpoints
+
+the sample has a few simple endpoints described with OpenAPI in `src/api`.
+
+=== ping
+
+    curl http://localhost:8080/ping
+
+=== echo
+
+    curl http://localhost:8080/echo?source=foo
+