API Blueprintのdockerが公開されていたので紹介

API仕様書を作るときはだいたい、API Blueprintとgulpを併用して作っている。ただ、環境を作るのが面倒だ。
dockerでなんとかできないものかと検索したら、すでにイメージを公開してくださっている方がいて、とても便利だったので紹介したい。

hub.docker.com

使い方

1. docker-compose.ymlを作る
2. 仕様書を保存しておく「docs」ディレクトリを作る
3. 仕様書を書いて拡張子「apib」で保存する

docker-compose.ymlは下記の通り。

version: '3.2'
services:
  blueprint-preview:
    image: sktbrt/api-blueprint-preview:latest
    volumes:
      - ./docs:/workspace/docs
    ports:
      - "8000:8000"

あとはdocsディレクトリに、例えば「api.apib」などとしてファイルを作成して中身を記述すればOKだ。
docker-compose up -d で起動して、 http://localhost:8000/api.html にアクセスすれば整形されたドキュメントを参照できる。