/openapi-asciidoctor

Generating HTML / PDF from Swagger / OpenAPI

Primary LanguageShell

About

Bash script for generating HTML and PDF documentation from OpenAPI format using swagger2markup and Asciidoctor.

Docs are generated with few formats transformations: OpenAPI => AsciiDoc => HTML and PDF

Example

Generated documentation: https://ajaxy.github.io/tinyspec

Requirements

  • Java
  • RubyGems:
gem install asciidoctor
gem install asciidoctor-pdf --pre

Usage with tinyspec:

tinyspec -j && \
    ../openapi-asciidoctor/asciidoc.sh openapi.json > docs/index.html && \
    rm openapi.json && \
    open docs/index.html