Swagger2Markup
github.com
Spec sheet
- Purpose
- Swagger2Markup combines handwritten material with automatically generated API documentation to produce an up-to-date REST API guide.Read 9 Oct 2026 · github.com
- Integrations
- The project documents use with Swagger JAX-RS, Springfox, Spring REST Docs, and Gradle and Maven plugins.Read 9 Oct 2026 · swagger2markup.github.io
- Support
- The project README directs questions to Gitter and asks users to report bugs and enhancement requests through GitHub issues and pull requests.Read 9 Oct 2026 · github.com
- License
- The project is licensed under Apache License 2.0.Read 9 Oct 2026 · github.com
- Build output
- AsciiDoc output can be converted to HTML, PDF, and EPUB using Asciidoctor tooling.Read 9 Oct 2026 · github.com
- CLI and Docker
- The reference documentation includes command-line usage and a Docker image section.Read 9 Oct 2026 · swagger2markup.github.io
- Compatibility limit
- The project README says it supports Swagger 1.2 and 2.0 specifications and requires at least JDK 8.Read 4 Oct 2026 · github.com
- Configuration
- Options include output markup language, output language, path grouping, generated examples, and document ordering.Read 9 Oct 2026 · swagger2markup.github.io
- Conversion options
- The converter can write output to a folder, write a single file, or return documentation as a string.Read 4 Oct 2026 · swagger2markup.github.io
- Customization
- It provides extension points for overview, paths, security, and definitions documents, and for modifying the Swagger model before conversion.Read 4 Oct 2026 · swagger2markup.github.io
- Distribution
- The documentation describes Swagger2Markup as a JAR library published in JCenter and Maven Central.Read 9 Oct 2026 · swagger2markup.github.io
- Extensions
- An extension SPI supports extending overview, paths, security, and definitions documents, and modifying the Swagger model before conversion.Read 9 Oct 2026 · swagger2markup.github.io
- Formats
- The documentation says AsciiDoc output can be converted to HTML, PDF, and EPUB using Asciidoctor tools.Read 4 Oct 2026 · swagger2markup.github.io
- Generated documentation
- By default, it generates four AsciiDoc files for overview, paths, security, and definitions, and can instead produce one file or a string.Read 4 Oct 2026 · swagger2markup.github.io
- Input and output
- It converts Swagger JSON or YAML into AsciiDoc, GitHub Flavored Markdown, or Atlassian Confluence Wiki documents.Read 4 Oct 2026 · swagger2markup.github.io
- Input location
- The Swagger specification can be read from a local file or a remote URL accessible over HTTP.Read 9 Oct 2026 · swagger2markup.github.io
- Maintenance
- The README says the maintainer can no longer maintain the project alone and lists Swagger v3 support and bug fixes among topics needing help.Read 4 Oct 2026 · github.com
- Maintenance status
- The maintainer says they can no longer maintain the project alone and welcomes community help, including work on Swagger v3 support and bug fixes.Read 9 Oct 2026 · github.com
- Output formats
- It converts Swagger JSON or YAML into AsciiDoc, GitHub Flavored Markdown, or Atlassian Confluence Wiki documents.Read 9 Oct 2026 · swagger2markup.github.io
- Output options
- The converter can generate separate overview, paths, security, and definitions files, or produce one file or a string.Read 9 Oct 2026 · swagger2markup.github.io
- Runtime requirement
- The project requires at least JDK 8.Read 9 Oct 2026 · github.com
Where Specifiction places it
- API Documentation Tools#27 of 277.0
