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

Сгенерируйте объявления типов TypeScript из того же артефакта OpenAPI 3.1, который показывает [справочник REST API](/api-reference/rest.md). Результат описывает контракт передачи данных, но не добавляет повторные попытки, вспомогательные средства пагинации, ожидание жизненного цикла или управление учетными данными.

## Перед началом[​](#before-you-begin "Прямая ссылка на Перед началом")

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

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

## Скачивание и проверка артефакта[​](#download-and-inspect-the-artifact "Прямая ссылка на Скачивание и проверка артефакта")

```
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[​](#generate-typescript-declarations "Прямая ссылка на Генерация объявлений типов 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[​](#verify-drift-in-ci "Прямая ссылка на Проверка расхождений в 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
```

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

## Текущее ограничение[​](#current-limitation "Прямая ссылка на Текущее ограничение")

Публичный артефакт OpenAPI намеренно неполон. Сгенерированные типы покрывают только операции, включенные в публичный список разрешенных. Специфичные для протоколов сообщения MCP, вебхуков и работы в реальном времени не являются типами OpenAPI. Используйте отдельные справочники [MCP](/api-reference/mcp.md), [вебхуков](/api-reference/webhooks.md) и [протоколов реального времени](/api-reference/realtime.md). Отдельная [страница совместимости с E2B](/developers/clients/e2b-compatibility.md) описывает эти преобразованные возможности SDK, поскольку они не являются собственным REST-контрактом Just Run.

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

## Связанные страницы[​](#related "Прямая ссылка на Связанные страницы")

* [Основы работы с API](/developers/api-fundamentals.md)
* [Персональные токены](/accounts/personal-access-tokens.md)
* [Справочник REST API](/api-reference/rest.md)
* [Справочник MCP](/api-reference/mcp.md)
* [Справочник вебхуков](/api-reference/webhooks.md)
* [Справочник протоколов реального времени](/api-reference/realtime.md)
* [Совместимость с E2B](/developers/clients/e2b-compatibility.md)
