Перейти к основному содержимому
Открыть Markdown

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

Сгенерируйте объявления типов TypeScript из того же артефакта OpenAPI 3.1, который показывает справочник REST API. Результат описывает контракт передачи данных, но не добавляет повторные попытки, вспомогательные средства пагинации, ожидание жизненного цикла или управление учетными данными.

Перед началом​

Нужны Node.js, npm и URL собранного сайта документации Just Run. Выберите выходной путь, принадлежащий вашему приложению.

export JUSTRUN_DOCS="https://your-just-run-docs-host"

Скачивание и проверка артефакта​

curl --fail-with-body --silent --show-error \
"$JUSTRUN_DOCS/openapi.json" \
--output just-run-openapi.json

jq -e '
.openapi == "3.1.0" and
.info.title == "just-run public REST API" and
(.paths | length > 0)
' just-run-openapi.json

Если нужна воспроизводимая генерация, закоммитьте входную спецификацию или зафиксируйте сборку документации в CI. Содержимое по неизменному URL документации может измениться после релиза продукта.

Генерация объявлений типов TypeScript​

Фронтенд Just Run использует openapi-typescript; сгенерируйте объявления типов той же проверенной основной версией:

npx --yes openapi-typescript@7.13.0 \
just-run-openapi.json \
--output src/generated/just-run-api.d.ts

Импортируйте типы операций и схем из созданного файла согласно вашей клиентской библиотеке. Клиент, который выполняет запросы, должен использовать адрес целевой инсталляции Just Run, а не URL документации, и добавлять bearer-токен только во время выполнения.

Проверка расхождений в CI​

Повторите генерацию во временный файл и сравните его с закоммиченным:

npx --yes openapi-typescript@7.13.0 \
just-run-openapi.json \
--output /tmp/just-run-api.d.ts

diff --unified src/generated/just-run-api.d.ts /tmp/just-run-api.d.ts

Перед принятием различий проверьте изменения контракта. Даже изменение схемы, совместимое по типам, может потребовать новой логики, например обработки дополнительного состояния жизненного цикла.

Текущее ограничение​

Публичный артефакт OpenAPI намеренно неполон. Сгенерированные типы покрывают только операции, включенные в публичный список разрешенных. Специфичные для протоколов сообщения MCP, вебхуков и работы в реальном времени не являются типами OpenAPI. Используйте отдельные справочники MCP, вебхуков и протоколов реального времени. Отдельная страница совместимости с E2B описывает эти преобразованные возможности SDK, поскольку они не являются собственным REST-контрактом Just Run.

На этом этапе мы не публикуем и не обещаем поддерживаемый Python SDK.