https://github.com/swagger2markup/swagger2markup-image
Docker image of Swagger2Markup
https://github.com/swagger2markup/swagger2markup-image
Last synced: about 1 year ago
JSON representation
Docker image of Swagger2Markup
- Host: GitHub
- URL: https://github.com/swagger2markup/swagger2markup-image
- Owner: Swagger2Markup
- License: apache-2.0
- Created: 2016-09-27T07:09:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-04-27T12:12:43.000Z (about 8 years ago)
- Last Synced: 2025-04-12T23:43:33.661Z (about 1 year ago)
- Language: Shell
- Size: 8.79 KB
- Stars: 19
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker image of Swagger2Markup
Swagger2Markup is a Swagger to AsciiDoc or Markdown converter. The primary goal of Swagger2Markup is to simplify the generation of an 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 specification. Internally it uses the official swagger-parser and my markup-document-builder.
The Swagger2Markup-CLI has been published as a Docker image on DockerHub.
## Reference Documentation
http://swagger2markup.github.io/swagger2markup/1.3.1/
## Usage Guide
You can pull the Swagger2Markup image as follows:
`docker pull swagger2markup/swagger2markup`
You can convert a Swagger Spec by running a Docker container as follows:
`docker run --rm -v $(pwd):/opt swagger2markup/swagger2markup convert -i /opt/swagger.yaml -f /opt/swagger -c /opt/config.properties`
You can also run swagger2markup by shell using `bin/swagger2markup.sh` as follows:
`./bin/swagger2markup convert -i /opt/swagger.yaml -f /opt/swagger -c /opt/config.properties`