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

Хранилище ключей и значений

Совместимые с JSON записи предпочтений и контекста со списком префиксов и операциями для каждой клавиши.

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

Песочница

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

Не подключено

Базовый URL Токен на предъявителя необязательный Токен сеанса необязательный

Как это работает

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

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

Операции

4 endpoint в kv группа, созданная на основе собственной сайдкара документ OpenAPI. Защищенные операции занимают Authorization: Bearer $CADCAMFUN_TOKEN; видеть аутентификация. Поведение и ограничения находятся в руководство по подсистеме.

получать	/api/kv	kv.list
получать	/api/kv/{key}	kv.get
помещать	/api/kv/{key}	kv.set
удалить	/api/kv/{key}	kv.remove

Операции хранения значений ключа в 3D Перетащите на орбиту · прокрутите, чтобы увеличить · перетащите вправо, чтобы панорамировать

Один блок на операцию (4), сгруппированный в каждом разделе ресурсов на этой странице и окрашенный в зависимости от метода: зеленый GET, оранжевый POST, синий PUT, фиолетовый PATCH, красный DELETE. Создается из документа OpenAPI во время сборки.

/api/kv

получать /api/kv # kv.list

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
префикс	запрос	нить \| null	необязательный

Ответы

200 объект application/json

{
  entries: Array<{
    key: string
    value: unknown
    updatedAt: string
  }>
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример ответа пойман · 200

ПОЛУЧИТЬ /api/kv

{
  "entries": []
}

Пример SDK

kv.list

import { CadCam } from "@cadcamfun/api/sdk"

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

// KvListInput
const result = await client.kv.list({})

curl

ПОЛУЧИТЬ /api/kv

curl --request GET "${CADCAMFUN_URL}/api/kv" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

префикс запрос

получать /api/kv/{key} # kv.get

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
ключ	путь	нить	необходимый

Ответы

200 объект application/json

{
  key: string
  value: unknown
  updatedAt: string
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

kv.get

import { CadCam } from "@cadcamfun/api/sdk"

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

// KvGetInput
const result = await client.kv.get({
  key: "<key>"
})

curl

ПОЛУЧИТЬ /api/kv/{key}

curl --request GET "${CADCAMFUN_URL}/api/kv/<key>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

ключ путь · требуется

помещать /api/kv/{key} # kv.set

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
ключ	путь	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  value: unknown
}

Ответы

200 объект application/json

{
  key: string
  value: unknown
  updatedAt: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

kv.set

import { CadCam } from "@cadcamfun/api/sdk"

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

// KvSetInput
const result = await client.kv.set({
  key: "<key>",
  value: null
})

curl

PUT /api/kv/{key}

curl --request PUT "${CADCAMFUN_URL}/api/kv/<key>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

ключ путь · требуется

Тело запроса application/json

удалить /api/kv/{key} # kv.remove

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
ключ	путь	нить	необходимый

Ответы

200 объект application/json

{
  message: string
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

kv.remove

import { CadCam } from "@cadcamfun/api/sdk"

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

// KvRemoveInput
const result = await client.kv.remove({
  key: "<key>"
})

curl

УДАЛИТЬ /api/kv/{key}

curl --request DELETE "${CADCAMFUN_URL}/api/kv/<key>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

ключ путь · требуется

Схемы

Именованные схемы, доступные из параметров, тел и ответов этой группы. А ? отмечает необязательное поле; | null отмечает поле, которое может иметь нулевое значение.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

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

Идентификаторы операций имеют вид kv.<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` строка.