Integ Docs | API

Appearance

Integ APIIntegration Management API

NestJS-based API for managing integrations from integ-core

Быстрый старт
Руководства
API Guide
🚀

Быстрый старт

Первоначальная настройка проекта за 15 минут с пошаговыми инструкциями

📖

Руководства

Ежедневный workflow, частые ошибки и решения типичных проблем

🔌

Интеграции

Документация и шаблоны для подключения внешних сервисов

📦

Пакеты

npm пакеты экосистемы Integ с API reference и примерами

🏗️

Архитектура

Модули, паттерны и бизнес-логика системы

📚

API Reference

Полная документация REST API с примерами запросов

Быстрый старт ​

bash
# Установка зависимостей
npm install

# Запуск локальной инфраструктуры
npm run docker:up

# Запуск миграций
npm run migration:run

# Запуск dev сервера
npm start

Структура документации ​

Для новых разработчиков ​

ДокументОписаниеПриоритет
Первоначальная настройкаНастройка проекта с нуля1
Ежедневный workflowТипичный рабочий день2
АрхитектураПонимание системы3

Для работы с API ​

ДокументОписание
АутентификацияJWT авторизация
ИнтеграцииCRUD операции
СекретыУправление credentials
Access TokensM2M аутентификация

Для добавления интеграций ​

ДокументОписание
Шаблон интеграцииКак документировать интеграцию
Шаблон пакетаКак документировать пакет
Правила документацииСтандарты написания

При проблемах ​

ДокументОписание
Частые ошибкиТипичные проблемы
TroubleshootingОбщие решения

API Endpoints ​

СервисURLОписание
REST APIhttp://localhost:3000/apiОсновной API
Reference (Public)http://localhost:3000/api/referenceПубличная документация
Reference (Internal)http://localhost:3000/api/reference-fullПолная документация
Health Checkhttp://localhost:3000/healthПроверка состояния
Docshttps://api.integ.docs.happ.toolsVitePress документация

Tech Stack ​

КатегорияТехнологияВерсия
FrameworkNestJS10.x
LanguageTypeScript5.x
DatabasePostgreSQL16
ORMTypeORM0.3.x
AuthJWT + Passport-
Validationclass-validator-
DocsScalar/OpenAPI-
LoggingPino-
TestingJest29

Полезные команды ​

bash
# Разработка
npm start                      # Dev сервер
npm run build                  # Сборка

# Качество кода
npm run lint:fix               # ESLint
npm run format                 # Prettier
npm run typecheck              # TypeScript

# База данных
npm run migration:generate     # Новая миграция
npm run migration:run          # Применить миграции

# Документация
npm run docs:dev               # VitePress dev