0.0.3 • Published 7 years ago
presidium-swagger v0.0.3
Presidium Swagger
A Java based tool built on top of Swagger2Markup for importing your API's Swagger into Presidium documentation.
Prerequisites
- Requires Java JDK 8+ and SLF4J to run
Generation
This tool can be run as a:
- Standalone executable
Part of your Presidium Project
Standalone
usage: presidium-swagger| Option | Description |
|---|---|
-d,--directory path | The destination directory to save the generated documentation to, defaults to: './docs'. |
| -h,--help | Shows this help. |
-s,--sourcepath path | Swagger source path. |
-t,--title string | Title of your docs folder, defaults to directory name supplied with '-d'. |
-u,--sourceurl url | URL to your Swagger Json file. |
Part Of Your Project
Include as part of the npm build building your Presidium site as in the following sample:
"scripts": {
"import-swagger-api" : "presidium-swagger"
},
"devDependencies": {
"presidium-swagger" : "#.#.#"
}Development
To build and run locally:
Uses the gradle application plugin:
gradle installDistInstalls to: build/install/presidium-swagger
Publish to NPM
$ gradle installDist
$ cd build/install/presidium-swagger
$ npm publish