Package org.javalite.activeweb.mojo

Class GenerateMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.javalite.activeweb.mojo.GenerateMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
@Mojo(name="generate", requiresDependencyResolution=COMPILE, defaultPhase=COMPILE) public class GenerateMojo extends org.apache.maven.plugin.AbstractMojo

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    apiLocation
    Directory that holds separate JSON files with docs for a specific action/HTTP method.
    protected String
    format
    Format, such as JSON or YAML
    protected org.apache.maven.project.MavenProject
    project
     
    protected String
    targetFile
     
    protected String
    templateFile
    File containing a template to merge the paths content into.

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

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    GenerateMojo()
     

  • Method Summary

    Modifier and Type
    Method
    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 Details

    • format

      @Parameter(required=true) protected String format
      Format, such as JSON or YAML

    • templateFile

      @Parameter(required=true) protected String templateFile
      File containing a template to merge the paths content into. Example:" { "openapi": "3.0.0", "info": { "title": "Simple API overview", "version": "3.0.0" }, "paths":{ } }

    • targetFile

      @Parameter(required=true) protected String targetFile

    • apiLocation

      @Parameter protected String apiLocation
      Directory that holds separate JSON files with docs for a specific action/HTTP method. If this is not provided, it will only source OpenAPI docs from GET,POST, PUT, etc annotations.

    • project

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

  • Constructor Details

    • GenerateMojo

      public GenerateMojo()

  • Method Details

    • execute

      public void execute()