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.
This commit is contained in:
@@ -0,0 +1,74 @@
|
||||
# API-шлюз
|
||||
|
||||
## Что такое API-шлюз?
|
||||
|
||||
BoosApi включает встроенный локальный API-сервер, который предоставляет настроенных провайдеров как **OpenAI-совместимые**, **нативные Claude** и **нативные Gemini** endpoints. Любой инструмент или клиент, использующий один из этих протоколов, может использовать BoosApi в качестве бэкенда — без отдельных ключей API или ретрансляционных сервисов.
|
||||
|
||||
Сценарии использования:
|
||||
|
||||
- Запускайте **Claude Code CLI**, **OpenAI Codex CLI**, **Gemini CLI** или **OpenCode** через BoosApi.
|
||||
- Подключайте расширения IDE к единому локально управляемому endpoint.
|
||||
- Делитесь набором ключей провайдера между множеством инструментов с ограничением частоты запросов на ключ.
|
||||
|
||||
---
|
||||
|
||||
## Начало работы
|
||||
|
||||
1. Откройте **Настройки → API-шлюз** (или нажмите <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd>).
|
||||
2. Нажмите **Запустить** для запуска сервера шлюза.
|
||||
3. По умолчанию сервер слушает на `127.0.0.1:8080` (HTTP).
|
||||
|
||||
::: tip
|
||||
Включите **Автозапуск** в настройках шлюза, чтобы сервер запускался автоматически при старте BoosApi.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Управление ключами API
|
||||
|
||||
1. Перейдите на вкладку **Ключи API**.
|
||||
2. Нажмите **Создать новый ключ**.
|
||||
3. Опционально добавьте **описание** для идентификации каждого ключа.
|
||||
4. Скопируйте ключ — он отображается только один раз.
|
||||
|
||||
---
|
||||
|
||||
## Шаблоны конфигурации
|
||||
|
||||
### Claude Code CLI
|
||||
|
||||
```bash
|
||||
claude config set --global apiUrl http://127.0.0.1:8080
|
||||
claude config set --global apiKey boosapi-xxxx
|
||||
```
|
||||
|
||||
### OpenAI Codex CLI
|
||||
|
||||
```bash
|
||||
export OPENAI_BASE_URL=http://127.0.0.1:8080/v1
|
||||
export OPENAI_API_KEY=boosapi-xxxx
|
||||
codex
|
||||
```
|
||||
|
||||
### Gemini CLI
|
||||
|
||||
```bash
|
||||
export GEMINI_API_BASE=http://127.0.0.1:8080
|
||||
export GEMINI_API_KEY=boosapi-xxxx
|
||||
gemini
|
||||
```
|
||||
|
||||
### Пользовательский клиент
|
||||
|
||||
```
|
||||
Base URL: http://127.0.0.1:8080/v1
|
||||
Ключ API: boosapi-xxxx
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Следующие шаги
|
||||
|
||||
- [Быстрый старт](./getting-started) — вернуться к руководству по быстрому старту
|
||||
- [Настройка провайдеров](./providers) — добавить upstream-провайдеров, к которым маршрутизирует шлюз
|
||||
- [MCP-серверы](./mcp) — подключить внешние инструменты для вызова ИИ-инструментов
|
||||
Reference in New Issue
Block a user