io.jooby.maven

Class OpenAPIMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.jooby.maven.BaseMojo

io.jooby.maven.OpenAPIMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="openapi",
      threadSafe=true,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      aggregator=true,
      defaultPhase=PROCESS_CLASSES)
public class OpenAPIMojo
extends BaseMojo

Generate an OpenAPI file from a jooby application. Usage: https://jooby.io/modules/openapi

Since:

2.7.0

Author:

edgar

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
OpenAPIMojo()

Method Summary

Modifier and Type	Method and Description
String	getExcludes() Regular expression used to excludes route.
String	getIncludes() Regular expression used to includes/keep route.
void	setExcludes(String excludes) Set Regular expression used to excludes route.
void	setIncludes(String includes) Set regular expression used to includes/keep route.

Methods inherited from class io.jooby.maven.BaseMojo

execute, getDependenciesResolver, getMainClass, getMaven, setDependenciesResolver, setMainClass, setMaven

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAPIMojo

public OpenAPIMojo()

Method Detail

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.