Class DefaultOpenApiExtension

java.lang.Object

io.micronaut.gradle.openapi.DefaultOpenApiExtension

All Implemented Interfaces:

OpenApiExtension

public abstract class DefaultOpenApiExtension
extends Object
implements OpenApiExtension

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPENAPI_GROUP

Constructor Summary

Constructors

Constructor	Description
DefaultOpenApiExtension(org.gradle.api.Project project, org.gradle.api.artifacts.Configuration classpath)

Method Summary

Modifier and Type	Method	Description
void	client(File file, org.gradle.api.Action<? super OpenApiClientSpec> spec)	Configures generation of a client, given a definition file.
void	client(String name, File definition, org.gradle.api.Action<? super OpenApiClientSpec> spec)	Configures generation of a server, given a definition file.
void	client(String name, org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> definition, org.gradle.api.Action<? super OpenApiClientSpec> spec)	Configures generation of a server, given a definition file.
void	server(File file, org.gradle.api.Action<? super OpenApiServerSpec> spec)	Configures generation of a server, given a definition file.
void	server(String name, File definition, org.gradle.api.Action<? super OpenApiServerSpec> spec)	Configures generation of a server, given a definition file.
void	server(String name, org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> definition, org.gradle.api.Action<? super OpenApiServerSpec> spec)	Configures generation of a server, given a definition file.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface OpenApiExtension

getVersion

Field Details

OPENAPI_GROUP

public static final String OPENAPI_GROUP

See Also:

• Constant Field Values

Constructor Details

DefaultOpenApiExtension

@Inject
public DefaultOpenApiExtension(org.gradle.api.Project project,
 org.gradle.api.artifacts.Configuration classpath)

Method Details

server

public void server(File file,
 org.gradle.api.Action<? super OpenApiServerSpec> spec)

Description copied from interface: OpenApiExtension

Configures generation of a server, given a definition file.

Specified by:

server in interface OpenApiExtension

Parameters:

file - the OpenAPI definition file

spec - configuration for the server generation

client

public void client(File file,
 org.gradle.api.Action<? super OpenApiClientSpec> spec)

Description copied from interface: OpenApiExtension

Configures generation of a client, given a definition file.

Specified by:

client in interface OpenApiExtension

Parameters:

file - the OpenAPI definition file

spec - configuration for the client generation

server

public void server(String name,
 org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> definition,
 org.gradle.api.Action<? super OpenApiServerSpec> spec)

Description copied from interface: OpenApiExtension

Configures generation of a server, given a definition file.

Specified by:

server in interface OpenApiExtension

Parameters:

name - an identifier used to uniquely refer to the generator, used to derive task names

definition - the OpenAPI definition file provider

spec - configuration for the server generation

client

public void client(String name,
 org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> definition,
 org.gradle.api.Action<? super OpenApiClientSpec> spec)

Description copied from interface: OpenApiExtension

Configures generation of a server, given a definition file.

Specified by:

client in interface OpenApiExtension

Parameters:

name - an identifier used to uniquely refer to the generator, used to derive task names

definition - the OpenAPI definition file provider

spec - configuration for the server generation

server

public void server(String name,
 File definition,
 org.gradle.api.Action<? super OpenApiServerSpec> spec)

Description copied from interface: OpenApiExtension

Configures generation of a server, given a definition file.

Specified by:

server in interface OpenApiExtension

Parameters:

name - an identifier used to uniquely refer to the generator, used to derive task names

definition - the OpenAPI definition file provider

spec - configuration for the server generation

client

public void client(String name,
 File definition,
 org.gradle.api.Action<? super OpenApiClientSpec> spec)

Description copied from interface: OpenApiExtension

Configures generation of a server, given a definition file.

Specified by:

client in interface OpenApiExtension

Parameters:

name - an identifier used to uniquely refer to the generator, used to derive task names

definition - the OpenAPI definition file provider

spec - configuration for the server generation