Skip to content

openapi-processor/openapi-processor-api

Repository files navigation

openapi-processor-api logo

openapi-processor-api

This library provides a simple api for any openapi-processor-* library. By implementing this api it will automatically work with the openapi-processor gradle plugin.

implementing the api

To make an openapi-processor available to the openapi-processor-gradle plugin it has to

  • implement the OpenApiProcessor interface.

    The gradle plugin uses the name provided by the api to configure the processor and to provide a task to run it.

  • and 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

openapi-processor-spring

openapi-processor-json

  • JsonProcessor (the entry point of the openapi-processor-json) implements the api interface
  • and the corresponding services property file in the resources.