APIドキュメント生成ツール「Slate」をDockerインストールする
はじめに
APIドキュメントを公開するために、ドキュメント生成ツール「Slate」を使ってみたので共有します。
APIドキュメント生成ツール「Slate」
よくあるAPIドキュメントのレイアウトですよね。Slateを使うとMarkdownで簡単にAPIドキュメントのページを作成できます。以下は採用しているプロジェクト例です。
GCP(Google Cloud Platform)でDockerを利用
今回は私が契約しているGCPを利用します。slateはDockerfileを用意しています。GCPでDockerを使う方法は2つありますが、今回は(2)でインストールしました。
(1)GKE(Google Container Engine)を使う
(2)GCE(Google Compute Engine)にDockerをインストールする
GCEにDockerをインストールする
GCE(ubuntu)にDockerをインストールする方法は、Dockerのサイトの手順どおりです。
sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D vi /etc/apt/sources.list.d/docker.list # deb https://apt.dockerproject.org/repo ubuntu-trusty main apt-get update apt-get purge lxc-docker apt-cache policy docker-engine sudo apt-get install linux-image-extra-$(uname -r) sudo apt-get install docker-engine sudo service docker start sudo docker run hello-world
Slateインストール
(1)SlateのリポジトリをFork
(2)git clone
git clone https://github.com/YOURUSERNAME/slate.git
(3)docker run
cd slate docker build -t slate . docker run -d -p 4567:4567 --name slate -v $(pwd)/source:/app/source slate
GCEポート開放
GCP Consoleからポート4567を開放
ブラウザからアクセス
まとめ
/slate/source/index.mdを変更してgit pushすると内容が反映します。簡単ですね。
