aap:apiary
Full name:
com.github.bednar:aap:0.1-SNAPSHOT:apiary
Description:
Generate Apiary Blueprint.
Attributes:
- Requires a Maven project to be executed.
Optional Parameters
| Name |
Type |
Since |
Description |
| apiBaseURL |
String |
0.1 |
API Base URL
Default value is: http://demoaap.apiary.io.
|
| apiaryOutput |
File |
0.1 |
Documentation output
Default value is: ${project.build.directory}/generated/apiary.
|
| appDescription |
File |
0.1 |
File with Description (support Markdown)
of Application
Default value is: ${project.basedir}/description.md.
|
| appName |
String |
0.1 |
Name of Application
Default value is: Demo Application.
|
| blueprintName |
String |
0.1 |
Apiary.io Blueprint file name
Default value is: Apiary.md.
|
Parameter Details
apiBaseURL:
API Base URL
- Type: java.lang.String
- Since: 0.1
- Required: No
- Default: http://demoaap.apiary.io
apiaryOutput:
Documentation output
- Type: java.io.File
- Since: 0.1
- Required: No
- Default: ${project.build.directory}/generated/apiary
appDescription:
File with Description (support
Markdown)
of Application
- Type: java.io.File
- Since: 0.1
- Required: No
- Default: ${project.basedir}/description.md
appName:
Name of Application
- Type: java.lang.String
- Since: 0.1
- Required: No
- Default: Demo Application
blueprintName:
- Type: java.lang.String
- Since: 0.1
- Required: No
- Default: Apiary.md
