2分で読めます

Bruno API コレクション

Zenovay Bruno コレクションは、External API のすべての公開エンドポイント用に事前設定された、無料のオープンソースリクエストセットです。Bruno はリクエストを git にチェックインするフォルダ内のプレーンな .bru ファイルとして保存します — 何もマシンの外には出ません。

Bruno は Postman のオープンソース代替です: クラウドアカウント不要、テレメトリーなし、シート単位の課金なし。

ダウンロード

ダウンロード + 開くBash

curl -O https://docs.zenovay.com/downloads/bruno-zenovay-collection.zip
unzip bruno-zenovay-collection.zip
# Bruno デスクトップアプリで bruno-zenovay-collection/ ディレクトリを開きます。

または直接取得: bruno-zenovay-collection.zip (約 16 KB)。

含まれるもの

コレクションには、以下のカテゴリにわたる 16 のすぐに実行できるリクエストが含まれます:

カテゴリ	リクエスト
アカウント	`GET /usage`
ウェブサイト	`GET /websites`, `GET /websites/:id`
Analytics	`GET /analytics/:id`, `/visitors`, `/pages`, `/countries`, `/technology`
Pro 機能	`GET /heatmaps/:id/pages`, `/replays/:id/sessions`, `/errors/:id/groups`
Insights	`GET /insights/:id`, `/anomalies/:id`, `/retention/:id`, `/revenue/:id/ltv`
Query Studio	`POST /query/:id`

各リクエストには以下が付属しています:

{{baseUrl}} で事前入力された完全な URL
環境から取得される正しい X-API-Key ヘッダー
各クエリパラメータの説明
ドキュメントタブのレスポンス例

セットアップ (60 秒)

Bruno をインストール — usebruno.com/downloads (macOS、Windows、Linux)。
コレクションを開く — ファイル → コレクションを開く → 解凍した bruno-zenovay-collection/ フォルダを選択。
環境を選ぶ — 右上のドロップダウン → production を選択 (デフォルトは https://api.zenovay.com/api/external/v1)。
API キーを追加 — 環境を開いて、apiKey を app.zenovay.com → 設定 → API キーのキーに設定。

以上です。任意のリクエストをクリックして Send を押します。

API キーは決してコミットされません。 Bruno は環境値を environments/ 配下の .env 形式のファイルに保存します — コレクションの .gitignore でそれらを除外しています。コミットされるファイル (environments/production.bru) には変数名のみが含まれ、シークレットは含まれません。

なぜ Postman ではなく Bruno か?

ローカルファースト — クラウド同期不要、チームアカウント不要
Git ネイティブ — .bru ファイルは PR 内できれいに diff される
テレメトリーなし — 何も自宅に電話しない
チーム無料 — 共有コレクションのシート単位の課金なし

すでに Postman を使用している場合、api.zenovay.com/openapi.json の OpenAPI 仕様もきれいにインポートできます。OpenAPI 仕様ページを参照。

ソース

コレクションは公開されている api-zenovay リポジトリの bruno/ 配下にあります。不足や古くなったリクエストを見つけた場合は、そこで issue や PR を開いてください。

Bruno API コレクション

ダウンロード

含まれるもの

セットアップ (60 秒)

なぜ Postman ではなく Bruno か?

ソース

関連