bruno-endpoint-creation

Bruno エンドポイントの作成

.bru エンドポイントファイルを作成するための、Bruno 固有のパターンです。REST の規約に精通していることを前提としています。

環境設定

開発（Local.bru）：

vars {
  baseUrl: http://localhost:3001
  linkId:
  apiKey: dev_api_key_change_in_production
}

本番／ステージング — 機密データには vars:secret を使用します：

vars {
  baseUrl: https://api.yourdomain.com
  linkId:
}
vars:secret [
  apiKey
]

コレクションレベルの認証

collection.bru で一度認証を設定すると、すべてのエンドポイントに継承されます：

auth {
  mode: bearer
}

auth:bearer {
  token: {{apiKey}}
}

個々のエンドポイントでは、auth: inherit を指定して継承します：

post {
  url: {{baseUrl}}/api/v1/resources
  body: json
  auth: inherit
}

認証がコレクションと異なる場合に限り、エンドポイントごとに上書きしてください。

リクエスト構造

meta {
  name: "Create Resource"
  type: http
  seq: 1
}

post {
  url: {{baseUrl}}/api/v1/resources
  body: json
  auth: inherit
}

body:json {
  {
    "resource": {
      "field1": "value1",
      "field2": "value2"
    }
  }
}

params:path {
  id: {{resourceId}}
}

params:query {
  page: 1
  limit: 20
  sort: created_at
  order: desc
}

スクリプト API

レスポンス後 — 後続のリクエストで使用するデータを抽出します：

script:post-response {
  if (res.status === 201 && res.body && res.body.id) {
    bru.setVar("resourceId", res.body.id);
  }
}

リクエスト前 — 動的なデータを生成します：

script:pre-request {
  const timestamp = Date.now();
  bru.setVar("uniqueEmail", `test-${timestamp}@example.com`);
}

主な違い：

• bru.setVar() — ランタイム変数（一時的で、現在のコレクションの実行中のみ有効）
• bru.setEnvVar() — 環境変数（保持され、「Environment」タブに表示されます）

テスト実行で抽出した ID などの一時的な値には、bru.setVar() を使用してください。

ドキュメントブロック

docs {
  Create a new resource in the system.

  **Required Fields:**
  - field1: Description
  - field2: Description

  **Optional Fields:**
  - optional_field: Description
}

コレクションのフォルダー構造

Bruno Collection/
├── Environments/
│   ├── Local.bru
│   ├── Staging.bru
│   └── Production.bru
├── Authentication/
│   ├── Login.bru
│   └── Refresh Token.bru
├── Resources/
│   ├── List Resources.bru
│   ├── Get Resource.bru
│   ├── Create Resource.bru
│   ├── Update Resource.bru
│   └── Delete Resource.bru
└── Health/
    └── Health Check.bru