You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -34,57 +33,67 @@ it will automatically work with the openapi-processor xref:gradle::index.adoc[gr
34
33
== implementing the api
35
34
36
35
To make an openapi-processor available to the
37
-
xref:gradle::index.adoc[openapi-processor-gradle plugin] or or the xref:maven::index.adoc[openapi-processor-maven plugin] it has to
36
+
xref:gradle::index.adoc[openapi-processor-gradle plugin] or the xref:maven::index.adoc[openapi-processor-maven plugin] it has to
38
37
39
-
- implement the link:{oap:api}[`v1.OpenApiProcessor`] interface.
38
+
- implement the link:{processor-v2}[`v2.OpenApiProcessor`] interface
39
+
+
40
+
recommended is to implement link:{processor-v1}[`v1.OpenApiProcessor`] to be compatible with previous versions of the gradle/maven plugin (it has the same methods, so it is just a matter of adding the interface).
40
41
+
41
42
the plugins use the name provided by `String getName();` to configure the processor and to provide the task to run it.
42
43
+
43
44
the plugins 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.
44
45
45
-
- provide a `META-INF/services/io.openapiprocessor.api.OpenApiProcessor` property file in the resources with the class name of the implementing class.
46
+
- provide a `META-INF/services/<package>.OpenApiProcessor` property file in the resources with the class name of the implementing class for all implemented interfaces (i.e. v2, v1).
47
+
48
+
- implement the link:{version-v2}[`v2.OpenApiProcessorVersion`] interface if you want to support the latest release check.
0 commit comments