Sign inSign up

fukuemon/postman_collection_update

By fukuemon

Updated almost 2 years ago

Image
0

223

fukuemon/postman_collection_update repository overview

OpenAPI の仕様書を元に Postman のコレクションを自動更新する Docker コンテナ

用意するもの

  • OpenAPI Specification ファイル

事前準備

1. APIKey とコレクション ID を用意する
APIKey

Postman のプロフィール画面 → 「EditProfile」 → 「API Keys」 「Generate API Key」で APIKey を作成。

コレクション ID

コレクションの三点マーク「•••」→「Share(共有)」→ 「Via API(API 経由)」のタブを開く

https://api.postman.com/collections/{{collection_id}}?access_key=

{{collection_id}}の部分がコレクション ID となる

2. APIKey・CollectionID・PathParameter を環境変数として定義する

.env

POSTMAN_API_KEY=
POSTMAN_COLLECTION_ID=
OPENAPI_FILE_PATH=
PATHPARAMETERS=
環境変数名説明
OPENAPI_FILE_PATHマウント先の OpenAPI のファイル Path (/忘れずに./internal/docs/openapi.json:/openapi.jsonとした場合
OPENAPI_FILE_PATH=/openapi.json
PATHPARAMETERSPostman の変数に置き換えたい PathParameter を定義する(半角スペース区切り)PATHPARAMETERS=facility_id position_id department_id team_id position_id

docker-compose を利用する場合

3. サービスを定義
services:
  ...(他のコンテナ定義)
  postman_collection_update:
    image: fukuemon/postman_collection_update
    volumes:
      - ./openapi.json:/openapi.json
    env_file:
      - .env
    profiles:
      - manual
4. サービスの実行
docker-compose run --rm postman_collection_update

or

docker compose run --rm postman_collection_update

単一のコンテナとして利用する場合

3. コンテナイメージをダウンロード・ローカルにビルド
docker pull fukuemon/postman_collection_update
4. コンテナの実行
docker run --env-file .env -v $(pwd)/{{OpenAPIのファイルpath}}:/{{OpenAPIのファイルpath}} --rm postman_collection_update

例:

docker run --env-file .env -v $(pwd)/openapi.json:/openapi.json --rm fukuemon/postman_collection_update

Tag summary

Content type

Image

Digest

sha256:6a2d27d1b

Size

54 MB

Last updated

almost 2 years ago

docker pull fukuemon/postman_collection_update