dev.jeka.plugins.openapi

Class JkOpenApi

java.lang.Object

dev.jeka.plugins.openapi.JkOpenApi

public class JkOpenApi
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
JkOpenApiSourceGenerator	addJavaGenerator(dev.jeka.core.api.project.JkProject project, java.lang.String specLocation, java.lang.String packageName) Appends a Java client code generation to the specified project.
JkOpenApiSourceGenerator	addSourceGenerator(dev.jeka.core.api.project.JkProject project, java.lang.String generatorName, java.lang.String specLocation) Appends a source generator to the specified project, generating code using the specified generatorName and the specified location for specification.
JkOpenApiSourceGenerator	addSourceGenerator(dev.jeka.core.api.project.JkProject project, java.lang.String generatorName, java.lang.String specLocation, java.lang.String packageName)
JkOpenApiSourceGenerator	addSpringbootServerGenerator(dev.jeka.core.api.project.JkProject project, java.lang.String specLocation, java.lang.String packageName) Appends a Springboot server code generation to the specified project.
static JkOpenApi	ofDefaultVersion() Creates a JkOpenApi using the default openApi cli version.
static JkOpenApi	ofVersion(java.lang.String version) Creates a JkOpenApi using the specified openApi cli version.

Methods inherited from class java.lang.Object

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

Method Detail

ofVersion

public static JkOpenApi ofVersion(java.lang.String version)

Creates a JkOpenApi using the specified openApi cli version.

ofDefaultVersion

public static JkOpenApi ofDefaultVersion()

Creates a JkOpenApi using the default openApi cli version.

addSourceGenerator

public JkOpenApiSourceGenerator addSourceGenerator(dev.jeka.core.api.project.JkProject project,
                                                   java.lang.String generatorName,
                                                   java.lang.String specLocation)

Appends a source generator to the specified project, generating code using the specified generatorName and the specified location for specification.

This returns a JkOpenApiSourceGenerator that can be customized.

Parameters:

generatorName - The code generator to use. See list here.

specLocation - The url or local path of the specification location.

addSourceGenerator

public JkOpenApiSourceGenerator addSourceGenerator(dev.jeka.core.api.project.JkProject project,
                                                   java.lang.String generatorName,
                                                   java.lang.String specLocation,
                                                   java.lang.String packageName)

Parameters:

packageName - the package name where source code should be generated

See Also:

addSourceGenerator(JkProject, String, String)

addSpringbootServerGenerator

public JkOpenApiSourceGenerator addSpringbootServerGenerator(dev.jeka.core.api.project.JkProject project,
                                                             java.lang.String specLocation,
                                                             java.lang.String packageName)

Appends a Springboot server code generation to the specified project. The generated model code will bbe prefixed with 'Rest'.

See Also:

addSourceGenerator(JkProject, String, String)

addJavaGenerator

public JkOpenApiSourceGenerator addJavaGenerator(dev.jeka.core.api.project.JkProject project,
                                                 java.lang.String specLocation,
                                                 java.lang.String packageName)

Appends a Java client code generation to the specified project. The generated model code will bbe prefixed with 'Rest'.

See Also:

addSourceGenerator(JkProject, String, String)