swagger2markup-cli

A Command line Interface (CLI) for Swagger2Markup.

License	Apache-2.0
Categories	CLI User Interface Swagger Program Interface REST Frameworks
GroupId	io.github.robwin
ArtifactId	swagger2markup-cli
Last Version	0.9.2
Release Date	Jan 6, 2016
Type	jar
Description	swagger2markup-cli A Command line Interface (CLI) for Swagger2Markup.
Project URL	https://github.com/Swagger2Markup/swagger2markup-cli
Source Code Management	https://github.com/Swagger2Markup/swagger2markup-cli.git

Download swagger2markup-cli

Filename	Size
swagger2markup-cli-0.9.2.pom
swagger2markup-cli-0.9.2.jar	9 MB
swagger2markup-cli-0.9.2-sources.jar	2 KB
swagger2markup-cli-0.9.2-javadoc.jar	25 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.github.robwin/swagger2markup-cli/ -->
<dependency>
    <groupId>io.github.robwin</groupId>
    <artifactId>swagger2markup-cli</artifactId>
    <version>0.9.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.github.robwin/swagger2markup-cli/
implementation 'io.github.robwin:swagger2markup-cli:0.9.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.github.robwin/swagger2markup-cli/
implementation ("io.github.robwin:swagger2markup-cli:0.9.2")

Apache Buildr

'io.github.robwin:swagger2markup-cli:jar:0.9.2'

Apache Ivy

<dependency org="io.github.robwin" name="swagger2markup-cli" rev="0.9.2">
  <artifact name="swagger2markup-cli" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.github.robwin', module='swagger2markup-cli', version='0.9.2')
)

Scala SBT

libraryDependencies += "io.github.robwin" % "swagger2markup-cli" % "0.9.2"

Leiningen

[io.github.robwin/swagger2markup-cli "0.9.2"]

Dependencies

compile (2)

Group / Artifact	Type	Version
io.github.robwin : swagger2markup	jar	0.9.2
io.airlift : airline	jar	0.7

Project Modules

There are no modules declared in this project.

swagger2markup-cli

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

Mac users can use Homebrew to install the Swagger2Markup CLI:

brew install swagger2markup-cli
swagger2markup 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.

Swagger2markup

A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation (HTML, PDF).

Versions

Version
0.9.2 Jan 6, 2016
0.9.1 Nov 17, 2015