Документация v2.4

Кузница структурных данных для разработчиков

Полный технический справочник по JsonForge. Настройте окружение, интегрируйте API и автоматизируйте генерацию типов за 5 минут.

Быстрый старт API Reference
Скриншот интерфейса документации JsonForge
Начало работы

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

Три шага от установки до первой сгенерированной модели данных.

1. Установка CLI

Установите глобальный инструмент через npm или yarn для управления проектами из терминала.

npm install -g @jsonforge/cli

2. Расширение VS Code

Получите подсветку синтаксиса и интеллисенс прямо в редакторе. Расширение автоматически подхватывает схемы из вашего проекта.

3. Генерация типов

Запустите команду экспорта, чтобы получить актуальные интерфейсы TypeScript или классы Java.

jf build --target ts
Интеграция

API Reference

Программный доступ ко всем функциям JsonForge. Интегрируйте валидацию и трансформацию данных прямо в ваш бэкенд или CI/CD пайплайн.

  • REST API Полный набор методов для управления схемами и проектами (JSON in / JSON out).
  • SDK Клиентские библиотеки для Node.js, Python и Go с поддержкой TypeScript.
  • Webhooks Автоматические триггеры при изменении схем или статуса билда.
Открыть Swagger UI
POST /api/v2/schemas/validate 200 OK 
{
  "schemaId": "usr_849201",
  "data": {
    "id": 1,
    "role": "admin",
    "isActive": true
  },
  "strictMode": true
}

Поддержка сообщества

Мы открыты для обратной связи и помощи. Присоединяйтесь к активному сообществу разработчиков JsonForge.

Discord Сервер

Общайтесь с командой разработки и другими пользователями в реальном времени. Каналы #help и #showcase.

GitHub Issues

Сообщайте об ошибках и предлагайте новые фичи. Мы отслеживаем тикеты и публикуем релиз-ноуты каждую пятницу.

База знаний

Статьи, туториалы и примеры кода. От "Hello World" до сложных паттернов трансформации данных.

Начните кодить прямо сейчас

Не тратьте время на документацию. Создайте схему и посмотрите, как работает магия.

Создать аккаунт