Перейти к содержанию
CADCAMFUN
Документы

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

Здоровье

Проверка работоспособности общедоступного процесса со статусом и меткой времени.

Автоматически переведено с английского. Смотреть оригинал на английском

Песочница

Отправьте эти запросы на свою работающую сайдкар. Значения остаются в этом браузере.

Не подключено
Как это работает

Сайдкар прослушивает порт обратной связи, выбранный при запуске, и печатает его в своем ready линия; используйте этот URL-адрес и CADCAMFUN_TOKEN с этого началось. Запросы идут прямо с этой страницы на этот адрес.

Sidecar отправляет заголовки CORS только источникам Tauri и http://localhost или http://127.0.0.1 в любом порту. Из размещенных документов браузер блокирует ответ, поэтому запускайте документы локально (bun run dev в packages/web), чтобы использовать игровую площадку, или скопируйте запрос как завиток. Чтобы поэкспериментировать, не затрагивая реальные данные, запустите сайдкар с помощью CADCAMFUN_DATA_DIR указал на одноразовый каталог — см. пошаговое руководство по API.

Операции

1 endpoint в health группа, созданная на основе собственной сайдкара документ OpenAPI. Каждая операция здесь является публичной. Поведение и ограничения находятся в руководство по подсистеме.

получать /api/health health.check
Медицинские операции в 3D Перетащите на орбиту · прокрутите, чтобы увеличить · перетащите вправо, чтобы панорамировать
Один блок на операцию (1), сгруппированный в каждом разделе ресурсов на этой странице и окрашенный в зависимости от метода: зеленый GET, оранжевый POST, синий PUT, фиолетовый PATCH, красный DELETE. Создается из документа OpenAPI во время сборки.

/api/health

получать /api/health # health.check

Публичный: токен носителя не требуется.

Ответы
200 объект application/json 
{
  status: string
  timestamp: string
  jobs?: {
    workers: number
    running: number
    waiting: number
    cached: number
    closing: boolean
  }
}
Пример ответа пойман · 200
ПОЛУЧИТЬ /api/здоровье 
{
  "status": "ok",
  "timestamp": "2026-10-15T04:52:23.303Z"
}
Пример SDK
health.check 
import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// no input
const result = await client.health.check()
curl
ПОЛУЧИТЬ /api/здоровье 
curl --request GET "${CADCAMFUN_URL}/api/health"
Попробуйте это

Звонок в эту группу

Идентификаторы операций имеют вид health.<name>. Сгенерированный Promise SDK (@cadcamfun/api/sdk) выставляет большинство из них как client.<namespace>.<method>(input), где input представляет собой один плоский объект параметров пути и полей тела; В примере SDK каждой карты показаны точный метод доступа и тип ввода. Многочастные загрузки, двоичные ответы или ответы JavaScript, а также необработанные веб-перехватчики не генерируются; эти карты показывают fetch вместо этого.

Ошибки Promise SDK 
import { CadCam, ClientError } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

try {
  await client.projects.list()
} catch (error) {
  if (error instanceof ClientError) {
    // Transport | UnexpectedStatus | UnsupportedContentType | MalformedResponse | SseEventTooLarge
  } else {
    // a declared error body: switch on error._tag
  }
}

Поиск неисправностей

СимптомВероятная причинаИсправить
401 на каждый вызовТокен от предыдущего запуска или отсутствует Bearer префиксОтправлять Authorization: Bearer <token> с жетоном, с которого была запущена сайдкар.
400 до того как что-либо произойдётТело или параметр не соответствует схемеСравните полезную нагрузку со схемой запроса на карте.
403 или 404 у записи, которую видно в другом местеДействующий счет отличаетсяОтправить право x-session-tokenили используйте локальный профиль, которому принадлежит запись.
409Конфликтующее состояние, например повторяющееся имя или устаревший заголовок ветки.Перечитайте ресурс и повторите попытку с текущими данными.
Попробуйте, написано «заблокировано CORS».Документы подаются из источника без обратной связи.Запустите документы локально или скопируйте запрос как curl.
В соединении отказаноСайдкар перезапустилась в новом портуПрочтите порт из нового ready строка.