Ubuntu19.10 API Blueprintをインストールして利用する

Ubuntu19.10 API Blueprintをインストールして利用する

API仕様書作成にAPI Blueprintを利用することになったので、環境構築手順を記載。 Markdown拡張形式で記述でき、htmlに変換可能。

環境

  • OS  ubuntu19.10
  • node v12.13.0
  • npm 6.12.1

※ubuntu19.10にnodeのインストールはこちら

インストール

専用のディレクトリ作成してインストールします。

apibファイルを作成

こちらの公式よりサンプルコードを貼り付けて、hello.apibファイルを作成します。

サーバー起動

下記のコマンドでローカルサーバーを起動して確認してみる

ブラウザから http://localhost:3000 にアクセスすると記述した内容が表示されます。

HTML作成

htmlに変換してみます。ここではhello.htmlと名前で作成します。

htmlが作成されます。