https://github.com/jkaushalya/swaggerdocumentgenerator
https://github.com/jkaushalya/swaggerdocumentgenerator
documentation generator swagger
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jkaushalya/swaggerdocumentgenerator
- Owner: JKAUSHALYA
- Created: 2017-03-07T13:02:34.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-04-18T06:26:57.000Z (about 7 years ago)
- Last Synced: 2025-06-02T11:30:48.423Z (about 1 year ago)
- Topics: documentation, generator, swagger
- Language: HTML
- Size: 276 KB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SWAGGER DOCUMENTATION GENERATOR
## Prerequisites
1. Java JDK 1.8 or later.
2. Apache Maven 3.0.5 or later.
## How to install
Clone this repo using "git clone https://github.com/JKAUSHALYA/swaggerdocumentgenerator.git"
## How to run the tool
1. If there are any custom templates to be used, add them to the templates folder.
2. Copy the swagger yaml file into the swagger-yaml folder.
3. Open the pom file using a text editor and update the property with
correct swagger file name.
4. Open a terminal and run "mvn clean install post-site" command.
5. If all success, there will be a message displaying "BUILD SUCCESS".
6. Generated documentation site will be available as "doc.zip" inside doc folder.