documentation

API Document Publication

API Document Publication

API Doc の公開方法調査するぞー todo openapi spec statis html generator とかで検索 redoc-cli が良さそうとの声 https://dev.classmethod.jp/articles/openapi-firebase-hosting/ swagger-codegen とかもあるかな license も気をつけて選択しなきゃねぇ 調査観点 must Open API Spec file で完結できること ある程度の可読性 なるべく sample req/res を充実させ, FAQ を潰す should 仕様と動作を整合させたい -> try ボタンと mock など
Gitbook

Gitbook

gitbook docker containerとか転がってるけど、まずは気持ちを新たに王道のインストールをして使い倒す。 いずれ docker container 化して、 nginx proxy のコンテナの後ろにドキュメントごとに設置したい。 インストールはほぼコレ: http://takemikami.com/2017/02/14/gitbook.html package.json に scripts を書いておくと便利 "scripts": { "dev": "gitbook serve", "build": "gitbook build", "pdf": "gitbook pdf",