読者です 読者をやめる 読者になる 読者になる

dackdive's blog

新米webエンジニアによる技術ブログ。JavaScript(React), Salesforce, Python など

follow us in feedly

API ドキュメント作成ツール

API Blueprintによるドキュメント開発環境【2016年冬】

ここから少しアップデートしたのでメモ。 リポジトリ 特徴 markdown -> html への変換には aglio、ローカルサーバーは --server オプションを使う ローカルで markdown ファイルを html に変換するのに aglio を使うところは以前と同じ。 改めて調べてみると…

aglioでAPI Blueprintを使ったドキュメント作成環境をローカルに構築する

(2016/11/24追記) 少々アップデートしました。 (追記ここまで) 以前、API ドキュメンテーションツールを色々検討していて Apiary.io を使ってみたんですが その時一緒に調べて気になっていた aglio というツールも試してみたところ、 どうやら自分にはこ…

APIドキュメント作成ツールまとめ

まとめというか、ちょいメモ。 API ドキュメント作成を楽にしてくれるツールを探しているんだけどいくつか出てきたので、 とりあえず整理。 おおむねこちらの Qiita の記事で紹介されているツールたち。 APIドキュメントを書くのが楽になるツールまとめ - Qi…

apiary.apibを複数ファイルに分割&任意のディレクトリに置く方法

TL;DR GitHub リポジトリを連携して Apiary.io を使っているとき、 以下のようにすると apiary.apib を複数ファイルに分割したり、好きなディレクトリの下に置いて管理することができる。が、非公式なので自己責任。 root ディレクトリに apiary.apib ととも…