io.jooby.openapi

Class OpenAPIGenerator

java.lang.Object

io.jooby.openapi.OpenAPIGenerator

public class OpenAPIGenerator
extends Object

Generate an OpenAPI model from a Jooby application. Optionally exports an OpenAPI model to a json or yaml file. Usage: https://jooby.io/modules/openapi

Author:

edgar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenAPIGenerator.Format Supported formats.

Constructor Summary

Constructors

Constructor and Description
OpenAPIGenerator()

Method Summary

Modifier and Type	Method and Description
Path	export(io.swagger.v3.oas.models.OpenAPI openAPI, OpenAPIGenerator.Format format) Export an OpenAPI model to the given format.
io.swagger.v3.oas.models.OpenAPI	generate(String classname) Generate an OpenAPI model from Jooby class.
Path	getBasedir() Base directory used it for loading openAPI template file name.
String	getExcludes() Regular expression used to excludes route.
String	getIncludes() Regular expression used to includes/keep route.
Path	getOutputDir() Set output directory used by export(OpenAPI, Format) operation.
String	getTemplateName() OpenAPI template file name, defaults is: openapi.yaml.
void	setBasedir(Path basedir) Set base directory used it for loading openAPI template file name.
void	setClassLoader(ClassLoader classLoader) Use a custom classloader for resolving class files.
void	setDebug(Set<DebugOption> debug) Set debug options.
void	setExcludes(String excludes) Set Regular expression used to excludes route.
void	setIncludes(String includes) Set regular expression used to includes/keep route.
void	setOutputDir(Path outputDir) Set output directory used by export(OpenAPI, Format).
void	setTemplateName(String templateName) Set openAPI template file name, defaults is: openapi.yaml.
String	toJson(io.swagger.v3.oas.models.OpenAPI openAPI) Generates a JSON version of the given model.
String	toYaml(io.swagger.v3.oas.models.OpenAPI openAPI) Generates a YAML version of the given model.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAPIGenerator

public OpenAPIGenerator()

Method Detail

export

@Nonnull
public Path export(@Nonnull
                            io.swagger.v3.oas.models.OpenAPI openAPI,
                            @Nonnull
                            OpenAPIGenerator.Format format)
                     throws IOException

Export an OpenAPI model to the given format.

Parameters:

openAPI - Model.

format - Format.

Returns:

Output file.

Throws:

IOException

generate

@Nonnull
public io.swagger.v3.oas.models.OpenAPI generate(@Nonnull
                                                          String classname)

Generate an OpenAPI model from Jooby class. This method parses class byte code and generates an open api model from it. Compilation must be done with debug information and parameters name available. Optionally, the conf/openapi.yaml is used as template and get merged into the final model.

Parameters:

classname - Application class name.

Returns:

Model.

toYaml

@Nonnull
public String toYaml(@Nonnull
                              io.swagger.v3.oas.models.OpenAPI openAPI)

Generates a YAML version of the given model.

Parameters:

openAPI - Model.

Returns:

YAML content.

toJson

@Nonnull
public String toJson(@Nonnull
                              io.swagger.v3.oas.models.OpenAPI openAPI)

Generates a JSON version of the given model.

Parameters:

openAPI - Model.

Returns:

JSON content.

setClassLoader

public void setClassLoader(@Nonnull
                           ClassLoader classLoader)

Use a custom classloader for resolving class files.

Parameters:

classLoader - Class loader.

setDebug

public void setDebug(Set<DebugOption> debug)

Set debug options.

Parameters:

debug - Debug options.

getTemplateName

public String getTemplateName()

OpenAPI template file name, defaults is: openapi.yaml.

Returns:

OpenAPI template file name, defaults is: openapi.yaml.

setTemplateName

public void setTemplateName(@Nonnull
                            String templateName)

Set openAPI template file name, defaults is: openapi.yaml.

Parameters:

templateName - OpenAPI template file name, defaults is: openapi.yaml.

setBasedir

public void setBasedir(@Nonnull
                       Path basedir)

Set base directory used it for loading openAPI template file name. Defaults is user.dir.

Parameters:

basedir - Base directory.

getBasedir

public Path getBasedir()

Base directory used it for loading openAPI template file name. Defaults is user.dir.

Returns:

Base directory used it for loading openAPI template file name.

getOutputDir

public Path getOutputDir()

Set output directory used by export(OpenAPI, Format) operation. Defaults to getBasedir().

Returns:

Get output directory.

getIncludes

@Nullable
public String getIncludes()

Regular expression used to includes/keep route. Example: /api/.*.

Returns:

Regular expression used to includes/keep route. Example: /api/.*.

setIncludes

public void setIncludes(@Nullable
                        String includes)

Set regular expression used to includes/keep route. Example: /api/.*.

Parameters:

includes - Regular expression.

getExcludes

@Nullable
public String getExcludes()

Regular expression used to excludes route. Example: /web.

Returns:

Regular expression used to excludes route. Example: /web.

setExcludes

public void setExcludes(@Nullable
                        String excludes)

Set Regular expression used to excludes route. Example: /web.

Parameters:

excludes - Regular expression used to excludes route. Example: /web.

setOutputDir

public void setOutputDir(@Nonnull
                         Path outputDir)

Set output directory used by export(OpenAPI, Format).

Parameters:

outputDir - Output directory.