dev.jeka.plugins.openapi

Class JkOpenApiSourceGenerator

java.lang.Object

dev.jeka.core.api.project.JkSourceGenerator

dev.jeka.plugins.openapi.JkOpenApiSourceGenerator

public class JkOpenApiSourceGenerator
extends dev.jeka.core.api.project.JkSourceGenerator

A JkSourceGenerator to be added to projects needing an openApi source generation.

Constructor Summary

Constructors

Constructor and Description
JkOpenApiSourceGenerator()

Method Summary

Modifier and Type	Method and Description
JkOpenApiSourceGenerator	customize(java.util.function.Consumer<JkOpenapiCmdBuilder> customizer) Defines the openApi command line to be executed for generating sources.
protected void	generate(dev.jeka.core.api.project.JkProject project, java.nio.file.Path generatedSourceDir)
java.lang.String	getDirName()
static JkOpenApiSourceGenerator	of(java.lang.String generatorName, java.lang.String specLocation) Creates a JkSourceGenerator instance, specifying the generator to use, and the specification location.
static JkOpenApiSourceGenerator	ofJavaClient(java.lang.String specLocation) Creates a JkSourceGenerator instance for generating Java client code.
static JkOpenApiSourceGenerator	ofSpringServer(java.lang.String specLocation) Creates a JkSourceGenerator instance for generating spring server code.
JkOpenApiSourceGenerator	setCliVersion(java.lang.String cliVersion) Sets the OpenApi generator cli version to invoke.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JkOpenApiSourceGenerator

public JkOpenApiSourceGenerator()

Method Detail

of

public static JkOpenApiSourceGenerator of(java.lang.String generatorName,
                                          java.lang.String specLocation)

Creates a JkSourceGenerator instance, specifying the generator to use, and the specification location.

Parameters:

generatorName - on generator selected from this list

specLocation - a file path or an url

ofSpringServer

public static JkOpenApiSourceGenerator ofSpringServer(java.lang.String specLocation)

Creates a JkSourceGenerator instance for generating spring server code.

Parameters:

specLocation - a file path or an url

ofJavaClient

public static JkOpenApiSourceGenerator ofJavaClient(java.lang.String specLocation)

Creates a JkSourceGenerator instance for generating Java client code.

Parameters:

specLocation - a file path or an url

setCliVersion

public JkOpenApiSourceGenerator setCliVersion(java.lang.String cliVersion)

Sets the OpenApi generator cli version to invoke.

customize

public JkOpenApiSourceGenerator customize(java.util.function.Consumer<JkOpenapiCmdBuilder> customizer)

Defines the openApi command line to be executed for generating sources. There is no need to specify the specification location here, as it has already been mentioned through the of(String, String) factory method.

Parameters:

customizer - A builder to construct command line conveniently.

getDirName

public java.lang.String getDirName()

Specified by:

getDirName in class dev.jeka.core.api.project.JkSourceGenerator

generate

protected void generate(dev.jeka.core.api.project.JkProject project,
                        java.nio.file.Path generatedSourceDir)

Specified by:

generate in class dev.jeka.core.api.project.JkSourceGenerator

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object