added antora docs

Author: hauner

docs/antora.yml

@@ -0,0 +1,5 @@
+name: api
+title: oap-api
+version: master
+nav:
+- modules/ROOT/nav.adoc

docs/modules/ROOT/images/openapi-processor-api@1280x200.png

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

docs/modules/ROOT/nav.adoc

@@ -0,0 +1,62 @@
+:author: Martin Hauner
+:page-title: openapi-processor-api
+:page-layout: default
+:page-aliases: current@api:ROOT:index.adoc, latest@api:ROOT:index.adoc
+:badge-license: https://img.shields.io/badge/License-Apache%202.0-blue.svg?labelColor=313A42
+:badge-ci: https://github.com/hauner/openapi-processor-api/workflows/ci/badge.svg
+:oapa-ci: https://github.com/hauner/openapi-processor-api/actions?query=workflow%3Aci
+:oapa-license: https://github.com/hauner/openapi-processor-api/blob/master/LICENSE
+//
+:oap-api: https://github.com/hauner/openapi-processor-api/blob/master/src/main/java/com/github/hauner/openapi/api/OpenApiProcessor.java
+:oap-spring-api-impl: https://github.com/hauner/openapi-processor-spring/blob/master/src/main/groovy/com/github/hauner/openapi/spring/processor/SpringProcessor.groovy
+:oap-spring-api-props: https://github.com/hauner/openapi-processor-spring/blob/master/src/main/resources/META-INF/services/com.github.hauner.openapi.api.OpenApiProcessor
+:oap-json-api-impl: https://github.com/hauner/openapi-processor-json/blob/master/src/main/groovy/com/github/hauner/openapi/spring/processor/JsonProcessor.groovy
+:oap-json-api-props: https://github.com/hauner/openapi-processor-json/blob/master/src/main/resources/META-INF/services/com.github.hauner.openapi.api.OpenApiProcessor
+
+
+//
+// content
+//
+image:openapi-processor-api$$@$$1280x200.png[openapi-processor-json]
+
+// badges
+//todo link:{oapa-ci}[image:{badge-ci}[]]
+link:{oapa-license}[image:{badge-license}[]]
+
+
+This library provides a simple api for an openapi-processor-* library. By implementing this api
+it will automatically work with the openapi-processor xref:gradle::index.adoc[gradle plugin].
+
+
+== implementing the api
+
+To make an openapi-processor available to the
+xref:gradle::index.adoc[openapi-processor-gradle plugin] it has to
+
+- implement the link:{oap:api}[`OpenApiProcessor`] interface.
++
+the gradle plugin uses the name provided by `String getName();` to configure the processor and to
+provide the task to run it.
++
+the gradle plugin will call `void run(Map<String, ?> options);` to run the processor, passing all
+extra settings in the options map with the property setting name as the key.
+
+- provide a `META-INF/services/com.github.hauner.openapi.api.OpenApiProcessor` property file in
+ the resources with the class name of the implementing class.
+
+
+== example implementations
+
+For examples see the implementations of
+
+*xref:spring::index.adoc[openapi-processor-spring]*
+
+- link:{oap-spring-api-impl}[`SpringProcessor`] (the entry point of the openapi-processor-spring)
+ implements the api interface
+- and the corresponding link:{oap-spring-api-props}[services property] file in the resources.
+
+*xref:json::index.adoc[openapi-processor-json]*
+
+- link:{oap-json-api-impl}[`JsonProcessor`] (the entry point of the openapi-processor-json)
+ implements the api interface
+- and the corresponding link:{oap-json-api-props}[services property] file in the resources.