JarCasting
JarCasting JarCasting

swagger2markup-cli

A Command line Interface (CLI) for Swagger2Markup.

License

License

Apache-2.0
Categories

Categories

CLI User Interface Swagger Program Interface REST Frameworks
GroupId

GroupId

io.github.swagger2markup
ArtifactId

ArtifactId

swagger2markup-cli
Last Version

Last Version

1.3.3
Release Date

Release Date
Type

Type

jar
Description

Description

swagger2markup-cli
A Command line Interface (CLI) for Swagger2Markup.
Project URL

Project URL

https://github.com/Swagger2Markup/swagger2markup-cli
Source Code Management

Source Code Management

https://github.com/Swagger2Markup/swagger2markup-cli.git

Download swagger2markup-cli

Filename Size
swagger2markup-cli-1.3.3.pom
swagger2markup-cli-1.3.3.jar 12 MB
swagger2markup-cli-1.3.3-sources.jar 2 KB
swagger2markup-cli-1.3.3-javadoc.jar 21 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/io.github.swagger2markup/swagger2markup-cli/ -->
<dependency>
    <groupId>io.github.swagger2markup</groupId>
    <artifactId>swagger2markup-cli</artifactId>
    <version>1.3.3</version>
</dependency>
// https://jarcasting.com/artifacts/io.github.swagger2markup/swagger2markup-cli/
implementation 'io.github.swagger2markup:swagger2markup-cli:1.3.3'
// https://jarcasting.com/artifacts/io.github.swagger2markup/swagger2markup-cli/
implementation ("io.github.swagger2markup:swagger2markup-cli:1.3.3")
'io.github.swagger2markup:swagger2markup-cli:jar:1.3.3'
<dependency org="io.github.swagger2markup" name="swagger2markup-cli" rev="1.3.3">
  <artifact name="swagger2markup-cli" type="jar" />
</dependency>
@Grapes(
@Grab(group='io.github.swagger2markup', module='swagger2markup-cli', version='1.3.3')
)
libraryDependencies += "io.github.swagger2markup" % "swagger2markup-cli" % "1.3.3"
[io.github.swagger2markup/swagger2markup-cli "1.3.3"]

Dependencies

compile (3)

Group / Artifact Type Version
io.github.swagger2markup : swagger2markup jar 1.3.3
io.airlift : airline jar 0.7
ch.qos.logback : logback-classic jar 1.1.2

Project Modules

There are no modules declared in this project.

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

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.

io.github.swagger2markup

Swagger2markup

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

Versions

Version
1.3.3
1.3.1
1.3.0
1.2.0
1.1.0
1.0.1
1.0.0