Repolode
instant-dev

instant-dev/api

JavaScript-фреймворк для создания типобезопасных веб-API: генерирует OpenAPI-спецификации из комментариев JSDoc и поддерживает потоковую передачу ответов LLM через SSE.

Звёзды
254
Форки
9
Открытые issues
2
Последний коммит
2 месяца назад

Что это?

Instant API — JavaScript-фреймворк для создания веб-API, в котором проверка типов выполняется на уровне HTTP-интерфейса. Разработчики описывают экспортируемую функцию-обработчик с помощью комментария в стиле JSDoc, а проверка и очистка параметров, а также проверка ответов выводятся из этих типов — отдельные библиотеки для проверки схем не нужны. Спецификация OpenAPI в форматах JSON и YAML, а также JSON Schema для вызова функций LLM автоматически генерируются в каталоге /.well-known/ сервера.

Пути к файлам в каталоге functions/ сопоставляются с HTTP-маршрутами, а экспортируемые функции GET, POST, PUT или DELETE обрабатывают запросы соответствующего метода. Фреймворк также раздаёт статические файлы из каталога www/, поддерживает тела запросов в форматах form-urlencoded, multipart и JSON, а по умолчанию устанавливает разрешающие заголовки CORS; ограничить доступ можно директивой @origin.

Для интеграций с ИИ и чатами обработчики могут передавать Server-Sent Events с помощью метода context.stream() и схемы @stream, а также сразу возвращать ответ 200, продолжая работу в фоновом режиме — это подходит для вебхуков Slack или Discord. Проект распространяется через npm под именем @instant.dev/api; его также используют вместе с инструментом командной строки instant.dev для настройки проектов, генерации обработчиков и развёртывания.

Ключевые возможности

  • 01Генерирует спецификации OpenAPI в форматах JSON и YAML из комментариев JSDoc.
  • 02Проверяет параметры и возвращаемые значения по объявленным типам, размерам и диапазонам.
  • 03Создаёт JSON Schema для вызова функций LLM.
  • 04Передаёт ответы в формате text/event-stream с помощью @stream и context.stream().
  • 05Выполняет обработчики в фоновом режиме, чтобы сразу возвращать ответы на вебхуки.
  • 06Раздаёт статические файлы из каталога www/ наряду с API-маршрутами.

Сценарии использования

  • Создание JSON API, где проверка запросов должна основываться на комментариях к функциям, а не на отдельной библиотеке схем.
  • Публикация обработчика на базе LLM, который передаёт токены в браузерный клиент.
  • Создание обработчика вебхуков Slack или Discord, который должен быстро ответить, а затем обработать запрос.
  • Публикация спецификации OpenAPI и схемы для вызова функций для существующего набора обработчиков.

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

  1. 1

    Установите инструменты командной строки instant.dev глобально

    npm i instant.dev -g
  2. 2

    Создайте папку для нового проекта и перейдите в неё

    cd ~/projects && mkdir my-new-project && cd my-new-project
  3. 3

    Инициализируйте проект

    instant init
  4. 4

    Запустите сервер

    instant serve

Что важно знать

  • Для максимально быстрой настройки нужны Node.js и CLI instant.dev.
  • В README указано, что это ранний выпуск, поэтому возможны изменения.

В подборках

Темы

Частые вопросы

Что такое api?
JavaScript-фреймворк для создания типобезопасных веб-API: генерирует OpenAPI-спецификации из комментариев JSDoc и поддерживает потоковую передачу ответов LLM через SSE. Instant API — JavaScript-фреймворк для создания веб-API, в котором проверка типов выполняется на уровне HTTP-интерфейса. Разработчики описывают экспортируемую функцию-обработчик с помощью комментария в стиле JSDoc, а проверка и очистка параметров, а также проверка ответов выводятся из этих типов — отдельные библиотеки для проверки схем не нужны. Спецификация OpenAPI в форматах JSON и YAML, а также JSON Schema для вызова функций LLM автоматически генерируются в каталоге /.well-known/ сервера.
api можно использовать бесплатно? Какая у него лицензия?
api распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
api всё ещё поддерживается?
Обновлялся за последние 6 месяцев. Последний коммит в api — 14 сент. 2026 г..
Для чего можно использовать api?
Создание JSON API, где проверка запросов должна основываться на комментариях к функциям, а не на отдельной библиотеке схем. Публикация обработчика на базе LLM, который передаёт токены в браузерный клиент. Создание обработчика вебхуков Slack или Discord, который должен быстро ответить, а затем обработать запрос. Публикация спецификации OpenAPI и схемы для вызова функций для существующего набора обработчиков.
Как установить api?
Установите инструменты командной строки instant.dev глобально: npm i instant.dev -g Создайте папку для нового проекта и перейдите в неё: cd ~/projects && mkdir my-new-project && cd my-new-project Инициализируйте проект: instant init Запустите сервер: instant serve
Где скачать api?
Исходный код и инструкции по установке — на GitHub: https://github.com/instant-dev/api

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты

API-шлюз с открытым исходным кодом для проксирования REST- и SOAP-сервисов, развертывания по OpenAPI, преобразования WSDL в OpenAPI, защиты через OAuth2/JWT и валидации сообщений.

658+2 за неделю186JavaApache-2.0Обновлён 1 час назад

Протокол и эталонный хаб на Go для доставки обновлений в реальном времени браузерам и HTTP-клиентам через Server-Sent Events.

5,4 тыс.+2 за неделю348GoAGPL-3.0Активно поддерживаетсяОбновлён 3 дня назад

Платформа для самостоятельного развертывания, которая предоставляет корпоративным приложениям и локальным LLM управляемый доступ к базам данных и сервисам через REST и MCP API.

Бэкенд и API#api-generation#rest-api#mcp
1,8 тыс.+1 за неделю354ShellApache-2.0Обновлён 3 дня назад

CLI для создания полноценных типобезопасных проектов на TypeScript с выбором фронтенда, бэкенда, базы данных, ORM, авторизации и дополнений.

5,9 тыс.+6 за неделю328TypeScriptMITАктивно поддерживаетсяОбновлён 14 дней назад