swagger2markup-cli

A Command line Interface (CLI) for Swagger2Markup.

Лицензия

Лицензия

Apache-2.0
Категории

Категории

CLI Взаимодействие с пользователем Swagger Межпрограммное взаимодействие REST Frameworks
Группа

Группа

io.github.robwin
Идентификатор

Идентификатор

swagger2markup-cli
Последняя версия

Последняя версия

0.9.2
Дата

Дата

Тип

Тип

jar
Описание

Описание

swagger2markup-cli
A Command line Interface (CLI) for Swagger2Markup.
Ссылка на сайт

Ссылка на сайт

https://github.com/Swagger2Markup/swagger2markup-cli
Система контроля версий

Система контроля версий

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

Скачать swagger2markup-cli

Как подключить последнюю версию

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

Зависимости

compile (2)

Идентификатор библиотеки Тип Версия
io.github.robwin : swagger2markup jar 0.9.2
io.airlift : airline jar 0.7

Модули Проекта

Данный проект не имеет модулей.

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.robwin

Swagger2markup

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

Версии библиотеки

Версия
0.9.2
0.9.1