Command line interface (CLI) for Swagger2Markup
Clone or download
Robert Winkler
Robert Winkler Released v1.3.3
Latest commit 15ad11c Apr 27, 2018

README.adoc

swagger2markup-cli

Build Status download

Overview

This is a CLI for Swagger2Markup. It 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.

Quick usage

You can clone and build the jar, then use this CLI to generate asciidocs.

gradle assemble
java -jar ./build/libs/swagger2markup-cli-X.X.X.jar convert -i the_swagger_file.json -d /the/path/to/output

That’s all! Then you can checkout http://asciidoctor.org/, find your way to to play with asciidocs.

Reference documentation

The documentation can be found at Reference documentation

License

Copyright 2015 Robert Winkler

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.