apikana:generate

Full name:

org.swisspush.maven.plugins:apikana-maven-plugin:0.4.14:generate

Description:

Generate JSON schemas and a user documentation in HTML from the given swagger and typescript models.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Binds by default to the lifecycle phase: generate-sources.

Optional Parameters

Name Type Since Description
api String - The main API file (yaml or json).
Default value is: src/openapi/api.yaml.
User property is: apikana.api.
apikanaVersion String - The apikana npm version to be used.
Default value is: 0.4.13.
User property is: apikana.version.
deploy boolean - If the sources should be copied into the output directory.
Default value is: false.
User property is: apikana.deploy.
downloadRoot String - The url to download npm and node from.
User property is: apikana.download-root.
global boolean - If the globally installed apikana node package should be used.
Default value is: false.
User property is: apikana.global.
javaPackage String - The java package that should be used.
User property is: apikana.java-package.
models String - The directory containing the models, if no API file is given.
Default value is: src/ts.
User property is: apikana.models.
nodeVersion String - The node version to be used.
Default value is: v7.5.0.
User property is: apikana.node-version.
nodeWorkingDir File - The working directory for node.
Default value is: target/node.
User property is: apikana.node-working-dir.
npmOptions String - Options to run npm with. This is used to install apikana and to run apikana.
User property is: apikana.npm-options.
npmVersion String - The npm version to be used.
Default value is: 4.2.0.
User property is: apikana.npm-version.
openBrowser boolean - If the browser should be opened to show the API.
Default value is: true.
User property is: apikana.open-browser.
pathPrefix String - The path prefix to be used in the generated *Paths.java file. If the property is not set or "null", the maximum possible path prefix is used.
User property is: apikana.path-prefix.
port int - The port of the HTTP server.
Default value is: 8333.
User property is: apikana.port.
serve boolean - If the API should be published via HTTP.
Default value is: true.
User property is: apikana.serve.
style String - The directory containing css files and images to style the swagger GUI.
Default value is: src/style.
User property is: apikana.style.

Parameter Details

api:

The main API file (yaml or json).
  • Type: java.lang.String
  • Required: No
  • User Property: apikana.api
  • Default: src/openapi/api.yaml

apikanaVersion:

The apikana npm version to be used.
  • Type: java.lang.String
  • Required: No
  • User Property: apikana.version
  • Default: 0.4.13

deploy:

If the sources should be copied into the output directory.
  • Type: boolean
  • Required: No
  • User Property: apikana.deploy
  • Default: false

downloadRoot:

The url to download npm and node from.
  • Type: java.lang.String
  • Required: No
  • User Property: apikana.download-root

global:

If the globally installed apikana node package should be used.
  • Type: boolean
  • Required: No
  • User Property: apikana.global
  • Default: false

javaPackage:

The java package that should be used.
  • Type: java.lang.String
  • Required: No
  • User Property: apikana.java-package

models:

The directory containing the models, if no API file is given.
  • Type: java.lang.String
  • Required: No
  • User Property: apikana.models
  • Default: src/ts

nodeVersion:

The node version to be used.
  • Type: java.lang.String
  • Required: No
  • User Property: apikana.node-version
  • Default: v7.5.0

nodeWorkingDir:

The working directory for node.
  • Type: java.io.File
  • Required: No
  • User Property: apikana.node-working-dir
  • Default: target/node

npmOptions:

Options to run npm with. This is used to install apikana and to run apikana.
  • Type: java.lang.String
  • Required: No
  • User Property: apikana.npm-options

npmVersion:

The npm version to be used.
  • Type: java.lang.String
  • Required: No
  • User Property: apikana.npm-version
  • Default: 4.2.0

openBrowser:

If the browser should be opened to show the API.
  • Type: boolean
  • Required: No
  • User Property: apikana.open-browser
  • Default: true

pathPrefix:

The path prefix to be used in the generated *Paths.java file. If the property is not set or "null", the maximum possible path prefix is used.
  • Type: java.lang.String
  • Required: No
  • User Property: apikana.path-prefix

port:

The port of the HTTP server.
  • Type: int
  • Required: No
  • User Property: apikana.port
  • Default: 8333

serve:

If the API should be published via HTTP.
  • Type: boolean
  • Required: No
  • User Property: apikana.serve
  • Default: true

style:

The directory containing css files and images to style the swagger GUI.
  • Type: java.lang.String
  • Required: No
  • User Property: apikana.style
  • Default: src/style