Введение
Добро пожаловать в документацию Slon6
Slon6.at — это комплексная платформа для управления микросервисами. Данное руководство содержит практические инструкции по настройке, интеграции и эксплуатации системы.
Совет: Если вы новый пользователь, начните с раздела
Быстрый старт, чтобы запустить первый сервис за 5 минут.
Что такое Slon6?
Slon6 предоставляет единый интерфейс для оркестрации распределенных систем. Платформа включает в себя API Gateway, систему мониторинга и централизованное хранилище конфигураций.
Ключевые возможности
- Автоматическое масштабирование — адаптация ресурсов под нагрузку в реальном времени.
- Встроенный Service Mesh — безопасная коммуникация между сервисами.
- Observability — трейсинг, метрики и логи в одном окне.
- Multi-region — поддержка 14 географических регионов из коробки.
Системные требования
• Node.js >= 18.0.0
• Docker >= 24.0
• RAM: минимум 4GB (рекомендуется 8GB)
• OS: Linux, macOS, Windows (WSL2)
Руководство
Быстрый старт с Slon6
Эта инструкция проведет вас через процесс создания и запуска первого сервиса в экосистеме slon6.at.
-
Установите CLI утилиту
Откройте терминал и выполните команду для глобальной установки:
npm install -g @slon6/cli
-
Инициализируйте проект
Создайте новую директорию и запустите мастер настройки:
mkdir my-service && cd my-service
slon6 init --template=microservice
-
Настройте переменные окружения
Скопируйте шаблон конфигурации и укажите ваш API ключ:
SLON_API_KEY=sk_live_xxxxxxxxxxxx
SLON_REGION=eu-west-1
PORT=3000
-
Запустите локально
Проверьте работоспособность сервиса:
Сервис будет доступен по адресу http://localhost:3000/health
Важно: Никогда не коммитьте файл .env в репозиторий. Добавьте его в .gitignore.
Практическое руководство
Настройка JWT авторизации
Инструкция по интеграции OAuth2/JWT аутентификации в ваш сервис Slon6.
Выбор стратегии
JWT Bearer
OAuth2 PKCE
API Key
Конфигурация JWT Middleware
Добавьте middleware в ваш основной файл приложения:
const { auth } = require('@slon6/sdk');
app.use(auth.jwt({
secret: process.env.JWT_SECRET,
issuer: 'slon6.at',
audience: 'api.slon6.at',
algorithms: ['RS256']
}));
// Защищенный роут
app.get('/api/profile', auth.required(), (req, res) => {
res.json({ user: req.user });
});
OAuth2 PKCE Flow
Рекомендуемый метод для SPA и мобильных приложений. Используйте endpoint /oauth/authorize с параметром code_challenge_method=S256.
API Key Authentication
Для server-to-server коммуникации передавайте ключ в заголовке:
GET /api/data HTTP/1.1
Host: api.slon6.at
X-API-Key: sk_live_xxxxxxxxxxxx
API Reference
Справочник кодов ошибок
Полный список кодов ответов API slon6.at с описанием причин и способов устранения.
| Код |
Название |
Описание |
Решение |
400 |
INVALID_PAYLOAD |
Тело запроса не соответствует схеме |
Проверьте JSON схему |
401 |
UNAUTHORIZED |
Отсутствует или истек токен |
Обновите токен |
429 |
RATE_LIMITED |
Превышен лимит запросов |
Используйте exponential backoff |
503 |
SERVICE_UNAVAILABLE |
Сервис временно недоступен |
Повторите через 30 сек |
Поддержка
Часто задаваемые вопросы
Ответы на самые популярные вопросы пользователей платформы slon6.
Как сбросить API ключ?
Перейдите в Dashboard → Settings → API Keys и нажмите "Regenerate". Старый ключ будет немедленно отозван.
Поддерживается ли GraphQL?
Да, начиная с версии SDK v3.2. Используйте флаг --graphql при инициализации проекта.
Какие лимиты бесплатного тарифа?
Free tier включает: 10K запросов/месяц, 2 сервиса, 1 регион, 7 дней хранения логов.
Как настроить CI/CD?
Используйте официальный GitHub Action slon6/deploy-action@v2. Пример конфигурации есть в разделе Deploy.
Установка
Подробная инструкция по установке для различных ОС...
Подключение базы данных
Настройка PostgreSQL, MongoDB и Redis...
Деплой в продакшн
Docker, Kubernetes и Serverless варианты...
Мониторинг и логи
Настройка алертов и дашбордов...
Обзор API
RESTful принципы и версионирование...
Эндпоинты
Полный список доступных маршрутов...
Устранение проблем
Диагностика распространенных ошибок...