JarCasting
JarCasting JarCasting

swagger2markup

A Swagger to Markup (AsciiDoc and Markdown) converter.

License

License
Categories

Categories

Swagger Program Interface REST Frameworks
GroupId

GroupId

io.github.robwin
ArtifactId

ArtifactId

swagger2markup
Last Version

Last Version

0.9.2
Release Date

Release Date
Type

Type

jar
Description

Description

swagger2markup
A Swagger to Markup (AsciiDoc and Markdown) converter.
Project URL

Project URL

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

Source Code Management

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

Download swagger2markup

Filename Size
swagger2markup-0.9.2.pom
swagger2markup-0.9.2.jar 37 KB
swagger2markup-0.9.2-sources.jar 24 KB
swagger2markup-0.9.2-javadoc.jar 85 KB
Browse

How to add to project

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

Dependencies

compile (5)

Group / Artifact Type Version
io.github.robwin : markup-document-builder jar 0.1.5
io.swagger : swagger-compat-spec-parser jar 1.0.13
commons-collections : commons-collections jar 3.2.1
commons-io : commons-io jar 2.4
org.slf4j : slf4j-api jar 1.7.12

Project Modules

There are no modules declared in this project.

Swagger2Markup

Build Status Coverage Status Codacy code quality download Apache License 2 Twitter Join%20Chat

Overview

Note
Dear community,
unfortunately I can’t maintain Swagger2Markup alone anymore. There are many interesting new topics:
1) Swagger v3 support
2) Fixing bugs
2) Merge Swagger2Markup repositories and create a new multi-module repository.
Any help is welcome.
Kind regards,
Robert

The primary goal of this project 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.
NOTE: The Swagger Specification has been donated to to the Open API Initiative (OAI) and has been renamed to the OpenAPI Specification.

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.

You can use Swagger2Markup to convert your contract-first Swagger YAML file into a human-readable format and combine it with hand-written documentation. As an alternative, you can choose the code-first approach and use Swagger2Markup together with Swagger JAX-RS, springfox or spring-restdocs. If you are Gradle or Maven user, you can also use the Swagger2Markup Gradle Plugin or Swagger2markup Maven Plugin.

AsciiDoc is preferable to Markdown as it has more features. AsciiDoc is a text document format for writing documentation, articles, books, ebooks, slideshows, web pages and blogs. AsciiDoc files can be converted to HTML, PDF and EPUB. AsciiDoc is much better suited for describing public APIs than JavaDoc or Annotations.

You can generate your HTML5, PDF and EPUB documentation via asciidoctorj or even better via the asciidoctor-gradle-plugin or asciidoctor-maven-plugin.

The project requires at least JDK 8.

Example

Swagger2Markup
Swagger2Markup definitions

Contributing

Community contributions

Pull requests are welcome.

Questions

You can ask questions about Swagger2Markup in Gitter.

Bugs

If you believe you have found a bug, please take a moment to search the existing issues. If no one else has reported the problem, please open a new issue that describes the problem in detail and, ideally, includes a test that reproduces it.

Enhancements

If you’d like an enhancement to be made to Swagger2Markup, pull requests are most welcome. The source code is on GitHub. You may want to search the existing issues and pull requests to see if the enhancement is already being worked on. You may also want to open a new issue to discuss a possible enhancement before work on it begins.

Companies who use Swagger2Markup

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

Versions

Version
0.9.2
0.9.1
0.9.0
0.8.0
0.7.1
0.7.0
0.6.3
0.6.2
0.6.1
0.6.0
0.5.3
0.5.2
0.5.1
0.5.0
0.4.0
0.3.0
0.2.4
0.2.3
0.2.2
0.2.1