1. HOME
  2. ブログ
  3. IT技術
  4. Swaggerで作成したAPIドキュメントをPDF化
Swaggerで作成したAPIドキュメントをPDF化

Swaggerで作成したAPIドキュメントをPDF化

APIドキュメントをPDF化

以前Swaggerを使ってAPIのドキュメントを作成する方法を紹介しました。

↓前回の記事↓

今回はそのドキュメントをPDFに変換する方法について紹介していきます。

PDF化する手順

Swaggerファイルを直接PDFファイルには変換できないので、Swagger → AsciiDoc → PDF という手順で変換していきます。

前提条件として homebrew, ruby, gem がインストールされていないといけません。

筆者の環境は以下の通りです。

SwaggerファイルをAsciiDocへ変換

SwaggerファイルをAsciidocへと変換する手順を紹介していきます。

Asciidoc への変換はswagger2markup-cliを使って行います。以下のコマンドでswagger2markup-cliをインストールします。

下記のコマンドでswaggerのファイルをAsciidocへ変換します。

保存先はコマンドで指定できます。上記のコマンドではルートディレクトリに保存するようにしています。

これでAsciidocファイルがいくつか生成されているので、次はこれをPDFファイルに変換していきます。

AsciiDocをPDFへ変換

AsciiDocをPDFへと変換する方法を紹介していきます。

まずは変換するために使用するasciidoctor-pdfをインストールします。

インストールが完了したら、下記のコマンドでpdfに変換していきます。

これでPDFファイルが生成されています。

使用するツールによっては日本語の変換がされない場合もあるようですが、この方法であれば特に気にすることなく日本語でのPDF変換ができるかと思います。

関連記事

採用情報

\ あの有名サービスに参画!? /

バックエンドエンジニア

\ クリエイティブの最前線 /

フロントエンドエンジニア

\ 世界を変える…! /

Androidエンジニア

\ みんなが使うアプリを創る /

iOSエンジニア