API Blueprint形式のドキュメント作成環境用Docker Imageをつくったよ

2020/1/13 書き溜め

WebAPIなどのサーバーを構築したら、
ドキュメントを作る必要がある。
それをWordやExcelでやるなんて耐えられない。。

やっぱりAPI Blueprint形式がいいよね。
開発者同士ならなおさら、フロントエンドとエクセル介したりしていられませんよ。

今回は,

先に成果物

dockerhubにアップロードしています。

下記のdocker-compose.ymlを配置してコマンド一発で
API blueprint環境が構築できます。

version: '3'
services:
  app:
    build: .
    ports:
      - "3000:3000"
    volumes:
      - ".:/app"
      - "app/node_modules"
      - "/app/work/"
    tty: true

version: '3'

services:

app:

build: .

ports:

- "3000:3000"

volumes:

- ".:/app"

- "app/node_modules"

- "/app/work/"

tty: true

起動する。

$ docker-compose up -d

1	$ docker-compose up -d

aglio: API Blueprintレンダラー

DockerImageの中にはAPI Blueprintレンダラーのaglioをインストールしています。
ドキュメントの書き方とかは、またまとめます。