swagger2markup-cli を Homebrew でインストール

プロジェクトリンク

• ホームページ

コマンドとエイリアス

• swagger2markup

プロジェクトの歴史

The Swagger2Markup/swagger2markup repository was created on GitHub in February 2015. Its README says the project was created by Robert Winkler to simplify generation of up-to-date REST API documentation by combining handwritten material with auto-generated output from Swagger descriptions.

採用の歴史

The README lists Maven and Gradle plugin integrations, a demo using Spring Boot, Springfox, and Spring REST Docs, and companies that used Swagger2Markup. GitHub releases show 1.x releases through v1.3.4, while the Homebrew formula packages the 1.3.3 CLI jar from Maven Central.

使われ方

Swagger2Markup converts local or remote Swagger JSON/YAML files into several AsciiDoc or Markdown documents. The Homebrew formula test invokes the packaged CLI as `swagger2markup convert -i test.yaml -f test`, producing an AsciiDoc output file.

パッケージ好きにとっての重要性

The package is notable because it reflects an era when API documentation pipelines were assembled from small CLIs, static site generators, AsciiDoc processors, and Swagger files. For maintainers, it is also an example of packaging a single Java jar as a Unix command with a stable executable name.

タイムライン

• 2015: GitHub repository created.
• 2016: v1.0.x releases added configuration, extension, security-document, and inline-schema features.
• 2018: v1.3.3 released.
• 2022: v1.3.4 listed in GitHub releases.
• 2026: Homebrew formula marks the CLI package deprecated as unmaintained.

Related projects

• The README relates Swagger2Markup to Swagger, swagger-parser, markup-document-builder, Asciidoctor, asciidoctorj, Springfox, Spring REST Docs, and its Maven and Gradle plugins.

ソース

• https://api.github.com/repos/Swagger2Markup/swagger2markup
• https://github.com/Swagger2Markup/swagger2markup#readme
• https://github.com/Swagger2Markup/swagger2markup/blob/master/RELEASENOTES.adoc
• https://raw.githubusercontent.com/Homebrew/homebrew-core/master/Formula/s/swagger2markup-cli.rb