Swaggerで作成したAPIドキュメントをPDF化
2022.07.01
APIドキュメントをPDF化
以前Swaggerを使ってAPIのドキュメントを作成する方法を紹介しました。
↓前回の記事↓
今回はそのドキュメントをPDFに変換する方法について紹介していきます。
PDF化する手順
Swaggerファイルを直接PDFファイルには変換できないので、Swagger → AsciiDoc → PDF という手順で変換していきます。
前提条件として homebrew, ruby, gem がインストールされていないといけません。
筆者の環境は以下の通りです。
1 2 3 4 5 6 7 8 | $ brew -v Homebrew 3.4.4 $ ruby -v ruby 2.6.9 $ gem -v 3.0.3.1 |
SwaggerファイルをAsciiDocへ変換
SwaggerファイルをAsciidocへと変換する手順を紹介していきます。
Asciidoc への変換はswagger2markup-cliを使って行います。以下のコマンドでswagger2markup-cliをインストールします。
1 | $ brew install swagger2markup-cli |
下記のコマンドでswaggerのファイルをAsciidocへ変換します。
1 | $ swagger2markup convert -i <swaggerファイル名> -d ./ |
保存先はコマンドで指定できます。上記のコマンドではルートディレクトリに保存するようにしています。
これでAsciidocファイルがいくつか生成されているので、次はこれをPDFファイルに変換していきます。
AsciiDocをPDFへ変換
AsciiDocをPDFへと変換する方法を紹介していきます。
まずは変換するために使用するasciidoctor-pdfをインストールします。
1 | $ gem install asciidoctor-pdf |
インストールが完了したら、下記のコマンドでpdfに変換していきます。
1 | $ asciidoctor-pdf -a scripts=cjk -a pdf-theme=default-with-fallback-font <asciidocファイル名> |
これでPDFファイルが生成されています。
使用するツールによっては日本語の変換がされない場合もあるようですが、この方法であれば特に気にすることなく日本語でのPDF変換ができるかと思います。
書いた人はこんな人
IT技術6月 6, 2023encoding.jsを使ってJavaScriptで文字コードを変換する- IT技術1月 19, 2023Laravelでboolean型にしたはずのデータがint型で返ってくる
- IT技術10月 17, 2022メンターをやってみて逆に学んだこと
- IT技術7月 1, 2022Swaggerで作成したAPIドキュメントをPDF化
関連記事
採用情報
\ あの有名サービスに参画!? /
バックエンドエンジニア
\ クリエイティブの最前線 /
フロントエンドエンジニア
\ 世界を変える…！ /
Androidエンジニア
\ みんなが使うアプリを創る /
iOSエンジニア
