Skip to content

Postman コレクション

TypeScript 型と同時に、Postman Collection v2.1 も OpenAPI 仕様から再生成されます。Postman にインポートするだけで、コードを書かずに 48 のエンドポイントを試せます。

ダウンロード

integration.postman_collection.json

Postman へのインポート手順

  1. Postman を開きます。
  2. File → Import(あるいは ⌘ + O / Ctrl + O)を選択します。
  3. ダウンロードした integration.postman_collection.json をダイアログにドラッグ&ドロップして確定します。

OpenAPI のタグに合わせたフォルダ(ProjectsModelsItemsAssetsComments など)が表示され、それぞれに対応するリクエストが並びます。

環境変数の設定

Postman の環境(Environment)を作成し、以下の変数を用意してからリクエストを送信してください:

変数名値の例
baseUrlhttps://cms.example.com/api
bearerToken発行済みの integration トークン
workspaceIdOrAliasws-1
projectIdOrAliasmy-proj

Authorization: Bearer をコレクションレベルで設定しておくと、配下のすべてのリクエストに引き継がれます。

Apache-2.0 ライセンスのもと公開されています。