org.apache.geronimo.microprofile.openapi.mojo

Class OpenAPIMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.geronimo.microprofile.openapi.mojo.OpenAPIMojo

All Implemented Interfaces:

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

@Mojo(name="openapi.json",
      defaultPhase=PROCESS_CLASSES,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      threadSafe=true)
public class OpenAPIMojo
extends org.apache.maven.plugin.AbstractMojo

Field Summary

Fields

Modifier and Type	Field and Description
protected String	application
protected File	classes
protected Map<String,String>	configuration
protected String	encoding
protected Collection<String>	endpointClasses
protected InfoImpl	info
protected String	operationNamingStrategy
protected File	output
protected boolean	prettify
protected org.apache.maven.project.MavenProject	project
protected boolean	skip

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
void	execute()

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

skip

@Parameter(property="geronimo-openapi.skip",
           defaultValue="false")
protected boolean skip

prettify

@Parameter(property="geronimo-openapi.prettify",
           defaultValue="true")
protected boolean prettify

output

@Parameter(property="geronimo-openapi.output",
           defaultValue="${project.build.outputDirectory}/META-INF/resources/openapi.json")
protected File output

encoding

@Parameter(property="geronimo-openapi.encoding",
           defaultValue="UTF-8")
protected String encoding

application

@Parameter
protected String application

endpointClasses

@Parameter
protected Collection<String> endpointClasses

configuration

@Parameter
protected Map<String,String> configuration

classes

@Parameter(defaultValue="${project.build.outputDirectory}")
protected File classes

operationNamingStrategy

@Parameter(property="geronimo-openapi.operationNamingStrategy",
           defaultValue="org.apache.geronimo.microprofile.openapi.impl.processor.spi.NamingStrategy$Default")
protected String operationNamingStrategy

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

info

@Parameter
protected InfoImpl info

Constructor Detail

OpenAPIMojo

public OpenAPIMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException