Goals available for this plugin:
Goal | Description |
---|---|
apikana:generate | Generate JSON schemas and a user documentation in HTML from the given swagger and typescript models. |
apikana:help | Display help information on apikana-maven-plugin. Call mvn apikana:help -Ddetail=true
-Dgoal=<goal-name> to display parameter details. |
apikana:package | Package the generated files in sources-jar, api-jar and style-jar. |
apikana:stop-server | Stop a possibly running HTTP server. |
The following specifies the minimum requirements to run this Maven plugin:
Maven | 3.1 |
JDK | 1.8 |
Memory | No minimum requirement. |
Disk Space | No minimum requirement. |
You should specify the version in your project's plugin configuration:
<project> ... <build> <!-- To define the plugin version in your parent POM --> <pluginManagement> <plugins> <plugin> <groupId>org.swisspush.maven.plugins</groupId> <artifactId>apikana-maven-plugin</artifactId> <version>0.4.14</version> </plugin> ... </plugins> </pluginManagement> <!-- To use the plugin goals in your POM or parent POM --> <plugins> <plugin> <groupId>org.swisspush.maven.plugins</groupId> <artifactId>apikana-maven-plugin</artifactId> <version>0.4.14</version> </plugin> ... </plugins> </build> ... </project>
For more information, see "Guide to Configuring Plug-ins"