Download
The primary goal of this project is to simplify the generation of up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation produced by Swagger. The result is intended to be an up-to-date, easy-to-read, on- and offline user guide, comparable to GitHub’s API documentation. The output of Swagger2Markup can be used as an alternative to swagger-UI and can be served as static content. Swagger2Markup converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specifications. Internally it uses the official swagger-parser and my markup-document-builder. You can use Swagger2Markup to convert your contract-first Swagger YAML file into a human-readable format.
Features
- The project requires at least JDK 8
- You can use Swagger2Markup to convert your contract-first Swagger YAML file into a human-readable format
- Combine it with hand-written documentation
- You can choose the code-first approach and use Swagger2Markup together with Swagger JAX-RS
- AsciiDoc is preferable to Markdown as it has more features
- You can generate your HTML5, PDF and EPUB documentation via asciidoctorj
Project Samples
