はじめに

APIの開発やテスト時に必要なモックサーバーを構築する際、Prismは非常に便利です。ここでは、Node、curl、Docker・Docker ComposeによるPrismのインストール・導入方法について解説します。

Nodeを通じたインストール

Prismはnpmパッケージとして提供されているため、npmを利用して簡単にインストールできます。以下のようにコマンドを実行すると、グローバルにPrismがインストールされます。

1npm install -g @stoplight/prism-cli
2# or
3yarn global add @stoplight/prism-cli

使い方は簡単で以下のようにコマンドを実行するだけです。

1prism mock <openapiファイルのpathまたはurl>

curlを使いgithubから直接バイナリーをインストールする

PrismのバイナリーはGitHubリポジトリからも直接ダウンロード可能です。以下のコマンドで、最新版のPrismバイナリーをインストールすることができます。

1curl -L https://raw.githack.com/stoplightio/prism/master/install | sh

使い方はNodeと同じく以下のようにコマンドを実行するだけです。

1prism mock <openapiファイルのpathまたはurl>

この方法では自動更新や更新のチェック等が行われないため、更新するためには再度インストールする必要があります。

Docker, Docker Composeを使いコンテナとして扱う

Dockerの場合は、以下のようにして簡単にコンテナとして起動することができます。

1docker run --init -p 4010:4010 stoplight/prism:4 mock -h 0.0.0.0 <openapiファイルのpathまたはurl>

Docker Composeの場合は、以下のようなdocker-compose.ymlファイルを作成し、docker-compose upコマンドを実行することで、Prismを起動できます。

docker-compose.yml
1version: '3'
2
3services:
4  prism:
5    image: stoplight/prism:latest
6    command: mock /path/to/openapi.yaml
7    ports:
8      - "4010:4010"
9    volumes:
10      - /path/to/openapi.yaml:/path/to/openapi.yaml
11  ...

最後に

以上が、Prismのインストール・導入方法についての解説でした。上手く用途に応じてインストールしてAPIの開発・テスト効率を向上させましょう。