Files

T

boos e0a5f57793 feat(desktop): embed BoosAPI Desktop client as a subproject

Vendor the rebranded BoosAPI Desktop client (Tauri + Vue) into metapi as
a monorepo subdirectory under desktop/. Source only — node_modules,
dist, Cargo target and the upstream .git history are excluded.

desktop/ keeps its own independent Cargo workspace (desktop/src-tauri
with crates/*); it is not part of the backend boosapi crate, so a
`cargo check` at the metapi root still compiles only the backend. Build
the desktop app from desktop/src-tauri per desktop/README.md.

Note: app icons are still placeholder assets pending the final BoosAPI
logo. The updater signing keys live outside the repo and are not
included.

2026-06-22 11:32:57 +08:00

6.8 KiB

Raw Blame History

API ゲートウェイ

API ゲートウェイとは？

BoosApi にはビルトインのローカル API サーバーが含まれており、設定されたプロバイダーを OpenAI 互換、Claude ネイティブ、Gemini ネイティブエンドポイントとして公開します。これらのプロトコルのいずれかを使用するツールやクライアントは、BoosApi をバックエンドとして使用できます — 別の API キーやリレーサービスは不要です。

ユースケース：

Claude Code CLI、OpenAI Codex CLI、Gemini CLI、OpenCode を BoosApi 経由で実行。
IDE 拡張機能を単一のローカル管理エンドポイントに接続。
1 セットのプロバイダーキーをキーごとのレート制限で多くのツールで共有。

はじめに

設定 → API ゲートウェイを開きます（または Cmd/Ctrl+Shift+G を押します）。
起動をクリックしてゲートウェイサーバーを起動します。
デフォルトでは、サーバーは 127.0.0.1:8080（HTTP）でリッスンします。設定タブでリッスンアドレスとポートを変更できます。

::: tip ゲートウェイ設定で自動起動を有効にすると、BoosApi 起動時にサーバーが自動的に起動します。 :::

API キー管理

ゲートウェイは、プロバイダーキーとは別に独自の API キーで受信リクエストを認証します。

API キータブに移動します。
新しいキーを生成をクリックします。
各キーを識別するためにオプションで説明を追加します（例：Claude Code、VS Code）。
キーをコピーします — 一度しか表示されません。

各キーにはプレフィックス、作成日、最終使用タイムスタンプが表示されます。キーはいつでも有効化/無効化または削除できます。

::: warning ゲートウェイキーは他の API キーと同様に扱ってください。キーを持つ人は誰でも、ゲートウェイが実行中にローカルゲートウェイにリクエストを送信できます。 :::

SSL/TLS

ゲートウェイは HTTP の他に HTTPS を提供できます。

自動生成証明書

設定タブを開きます。
SSL/TLS を有効にして生成モードを選択します。
BoosApi が自己署名証明書と秘密鍵を以下に作成します：
```
~/.boosapi/ssl/cert.pem
~/.boosapi/ssl/key.pem
```
HTTPS ポートを設定します（デフォルト 8443）。
オプションでSSL 強制を有効にして、すべての HTTP リクエストを HTTPS にリダイレクトします。

カスタム証明書

アップロードモードを選択して、独自の証明書と秘密鍵ファイルのパスを提供します。

::: info 秘密鍵は Unix システムではファイルモード 0600 で保存され、他のユーザーが読み取れないようにします。 :::

使用状況分析

メトリクスタブにはゲートウェイアクティビティを監視するためのダッシュボードが表示されます：

ビュー	説明
API キー別	各ゲートウェイキーによるリクエスト量とトークン使用量
プロバイダー別	各アップストリーム AI プロバイダーへのリクエストとトークン
日別	時間経過による日次使用トレンド

これらのダッシュボードを使用してコストを追跡し、異常を発見し、プロバイダー間で負荷を分散します。

リクエストログ

概要タブには以下の詳細を含む最近のリクエストログが表示されます：

タイムスタンプ、HTTP メソッド、パス
ステータスコードとレスポンスタイム
使用されたプロバイダーとモデル
トークン数（プロンプト + 補完）

任意のログエントリをクリックして完全なリクエストとレスポンスを確認します。ログをクリアボタンでログ履歴をリセットします。

設定テンプレート

BoosApi には人気の CLI ツール用の既製設定スニペットが付属しています。テンプレートタブに移動し、ツールを選択してコピーをクリックして必要な設定を取得します。

Claude Code CLI

claude config set --global apiUrl http://127.0.0.1:8080
claude config set --global apiKey boosapi-xxxx

OpenAI Codex CLI

export OPENAI_BASE_URL=http://127.0.0.1:8080/v1
export OPENAI_API_KEY=boosapi-xxxx
codex

OpenCode

OpenCode 設定に追加します：

{
  "provider": "openai",
  "baseURL": "http://127.0.0.1:8080/v1",
  "apiKey": "boosapi-xxxx"
}

Gemini CLI

export GEMINI_API_BASE=http://127.0.0.1:8080
export GEMINI_API_KEY=boosapi-xxxx
gemini

カスタムクライアント

OpenAI 互換のベース URL を受け入れるツールはゲートウェイに接続できます：

Base URL:  http://127.0.0.1:8080/v1
API Key:   boosapi-xxxx

boosapi-xxxx を API キータブで生成したキーに置き換えます。SSL が有効な場合は https:// とポート 8443（または設定した HTTPS ポート）を使用します。

外部ツールの接続

以下は OpenAI 互換クライアントを接続するための一般的なパターンです：

BoosApi でゲートウェイ API キーを生成します。
ツールの設定でベース URL を http://127.0.0.1:8080/v1（または HTTPS の同等）に設定します。
API キーを生成したゲートウェイキーに設定します。
BoosApi プロバイダーのいずれかに設定したモデルを選択します。
ツールを使用し始めます — すべてのリクエストは BoosApi を経由してアップストリームプロバイダーにルーティングされます。

::: tip ツールが特定の API 形式（例：Claude または Gemini ネイティブ）を必要とする場合、BoosApi はリクエスト形式を自動的に検出して正しいプロバイダーにルーティングします。形式ごとに別のエンドポイントを設定する必要はありません。 :::

次のステップ

クイックスタート — クイックスタートガイドに戻る
プロバイダーの設定 — ゲートウェイがルーティングするアップストリームプロバイダーの追加
MCP サーバー — AI ツール呼び出しのための外部ツールの接続

6.8 KiB Raw Blame History Unescape Escape