Package io.openapiprocessor.api

Interface OpenApiProcessor

All Superinterfaces:

OpenApiProcessor

@Deprecated
public interface OpenApiProcessor
extends OpenApiProcessor

Deprecated.

use OpenApiProcessor instead.

To make an openapi-processor available to a consumer (for example the openapi-processor-gradle plugin) it must implement this interface and have a META-INF/services/io.openapiprocessor.api.OpenApiProcessor property file in the resources with the class name of the implementing class.

A consumer should be able to provide access to any processor that is found on the class path. The gradle plugin uses the name provided by the api to configure the processor and to provide a task to run it. This task will find and run an openapi-processor by using the OpenApiProcessor service interface. By using an interface it does not need an explicit dependency on a processor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Deprecated. The identifying name of the openapi-processor.
void	run(java.util.Map<java.lang.String,?> options)	Deprecated. Runs the openapi-processor with the given options.

Method Detail

getName

java.lang.String getName()

Deprecated.

The identifying name of the openapi-processor. *Should* be globally unique so a consumer of this interface can distinguish between different openapi-processors.

It is recommended to return here the last part of the full openapi-processor name. If the processor jar name is openapi-processor-spring the name should be spring.

Specified by:

getName in interface OpenApiProcessor

Returns:

the unique name of the openapi-processor

run

void run(java.util.Map<java.lang.String,?> options)

Deprecated.

Runs the openapi-processor with the given options. The options are key value pairs. Keys are of type String and values are of any type. A property hierarchy is possible by using Maps as value.

Specified by:

run in interface OpenApiProcessor

Parameters:

options - the openapi-processor configuration