Documentação

Biblioteca

Registros de biblioteca compartilhados e coleções de pesquisa de componentes, materiais e ferramentas.

Traduzido automaticamente do inglês. Ver o original em inglês

Área de testes

Envie essas solicitações para seu próprio sidecar em execução. Os valores permanecem neste navegador.

Não conectado

URL base Token do portador opcional Token de sessão opcional

Como isso funciona

O sidecar escuta em uma porta de loopback escolhida na inicialização e a imprime em seu ready linha; use esse URL e o CADCAMFUN_TOKEN foi iniciado. As solicitações vão direto desta página para esse endereço.

O sidecar envia cabeçalhos CORS apenas para as origens Tauri e para http://localhost ou http://127.0.0.1 em qualquer porto. Nos documentos hospedados, o navegador bloqueia a resposta, então execute os documentos localmente (bun run dev em packages/web) para usar o playground ou copie a solicitação como curl. Para experimentar sem tocar em dados reais, inicie o sidecar com CADCAMFUN_DATA_DIR apontado para um diretório descartável - veja o passo a passo da API.

Operações

8 endpoints no library grupo, gerado a partir do próprio sidecar Documento OpenAPI. As operações protegidas levam Authorization: Bearer $CADCAMFUN_TOKEN; ver autenticação. Comportamento e limites estão em o guia do subsistema.

pegar	/api/library	library.list
publicar	/api/library	library.create
pegar	/api/library/{id}	library.get
colocar	/api/library/{id}	library.update
excluir	/api/library/{id}	library.remove
pegar	/api/library/components	library.components
pegar	/api/library/materials	library.materials
pegar	/api/library/tools	library.tools

Operações da biblioteca em 3D Arraste para orbitar · role para ampliar · arraste com o botão direito para deslocar

Um bloco por operação (8), empilhado por seção de recursos desta página e colorido por método: verde GET, laranja POST, azul PUT, violeta PATCH, vermelho DELETE. Gerado a partir do documento OpenAPI em tempo de construção.

/api/library

pegar /api/library # library.list

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
categoria	consulta	corda \| null	opcional
tipo	consulta	corda \| null	opcional
procurar	consulta	corda \| null	opcional

Respostas

200 Matriz<objeto> application/json

Array<{
  id: string
  name: string
  description: string | null
  category: string
  type: string
  data: unknown
  properties: unknown
  tags: unknown
  thumbnail: string | null
  isPublic: boolean
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Resposta de exemplo capturado · 200

GET /api/biblioteca

[]

Exemplo de SDK

library.list

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

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

// LibraryListInput
const result = await client.library.list({})

curl

GET /api/biblioteca

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

Experimente

categoria consulta tipo consulta procurar consulta

publicar /api/library # library.create

Requer Authorization: Bearer <token>.

Corpo da solicitação · obrigatório · aplicação/json

{
  name?: string | null
  description?: string | null
  category?: string | null
  type?: string | null
  data?: unknown | null
  properties?: unknown | null
  tags?: unknown | null
  organizationId?: string | null
  isPublic?: boolean | null
}

Respostas

201 objeto application/json

{
  id: string
  name: string
  description: string | null
  category: string
  type: string
  data: unknown
  properties: unknown
  tags: unknown
  thumbnail: string | null
  isPublic: boolean
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemplo de SDK

library.create

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

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

// LibraryCreateInput
const result = await client.library.create({
  name: "",
  description: "",
  category: "",
  type: "",
  data: null,
  properties: null,
  tags: null,
  organizationId: "",
  isPublic: false
})

curl

POST /api/biblioteca

curl --request POST "${CADCAMFUN_URL}/api/library" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Experimente

Solicitar corpo application/json

pegar /api/library/{id} # library.get

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto application/json

{
  id: string
  name: string
  description: string | null
  category: string
  type: string
  data: unknown
  properties: unknown
  tags: unknown
  thumbnail: string | null
  isPublic: boolean
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemplo de SDK

library.get

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

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

// LibraryGetInput
const result = await client.library.get({
  id: "<id>"
})

curl

GET /api/library/{id}

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

Experimente

eu ia caminho · obrigatório

colocar /api/library/{id} # library.update

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Corpo da solicitação · obrigatório · aplicação/json

{
  name?: string | null
  description?: string | null
  category?: string | null
  type?: string | null
  data?: unknown | null
  properties?: unknown | null
  tags?: unknown | null
  organizationId?: string | null
  isPublic?: boolean | null
}

Respostas

200 objeto application/json

{
  id: string
  name: string
  description: string | null
  category: string
  type: string
  data: unknown
  properties: unknown
  tags: unknown
  thumbnail: string | null
  isPublic: boolean
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemplo de SDK

library.update

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

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

// LibraryUpdateInput
const result = await client.library.update({
  id: "<id>",
  name: "",
  description: "",
  category: "",
  type: "",
  data: null,
  properties: null,
  tags: null,
  organizationId: "",
  isPublic: false
})

curl

PUT /api/library/{id}

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

Experimente

eu ia caminho · obrigatório

Solicitar corpo application/json

excluir /api/library/{id} # library.remove

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto application/json

{
  message: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemplo de SDK

library.remove

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

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

// LibraryRemoveInput
const result = await client.library.remove({
  id: "<id>"
})

curl

DELETE /api/library/{id}

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

Experimente

eu ia caminho · obrigatório

/api/library/components

pegar /api/library/components # library.components

Requer Authorization: Bearer <token>.

Respostas

200 objeto application/json

{
  data: Array<{
    id: string
    name: string
    description: string | null
    category: string
    type: string
    data: unknown
    properties: unknown
    tags: unknown
    thumbnail: string | null
    isPublic: boolean
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
    owner: {
      id: string
      name: string | null
      email: string | null
      image: string | null
    } | null
  }>
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

Resposta de exemplo capturado · 200

GET /api/library/componentes

{
  "data": []
}

Exemplo de SDK

library.components

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.library.components()

curl

GET /api/library/componentes

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

Experimente

/api/library/materials

pegar /api/library/materials # library.materials

Requer Authorization: Bearer <token>.

Respostas

200 objeto application/json

{
  data: Array<{
    id: string
    name: string
    description: string | null
    properties: unknown
    isPublic: boolean
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
    owner: {
      id: string
      name: string | null
      email: string | null
      image: string | null
    } | null
  }>
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

Resposta de exemplo capturado · 200

GET /api/biblioteca/materiais

{
  "data": []
}

Exemplo de SDK

library.materials

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.library.materials()

curl

GET /api/biblioteca/materiais

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

Experimente

/api/library/tools

pegar /api/library/tools # library.tools

Requer Authorization: Bearer <token>.

Respostas

200 objeto application/json

{
  data: Array<{
    id: string
    name: string
    type: string
    diameter: number | "Infinity" | "-Infinity" | "NaN"
    material: string
    numberOfFlutes: number | "Infinity" | "-Infinity" | "NaN" | null
    maxRPM: number | "Infinity" | "-Infinity" | "NaN" | null
    coolantType: string | null
    cuttingLength: number | "Infinity" | "-Infinity" | "NaN" | null
    totalLength: number | "Infinity" | "-Infinity" | "NaN" | null
    shankDiameter: number | "Infinity" | "-Infinity" | "NaN" | null
    cornerRadius?: number | "Infinity" | "-Infinity" | "NaN" | null
    tipAngle?: number | "Infinity" | "-Infinity" | "NaN" | null
    threadPitch?: number | "Infinity" | "-Infinity" | "NaN" | null
    holderDiameter?: number | "Infinity" | "-Infinity" | "NaN" | null
    holderLength?: number | "Infinity" | "-Infinity" | "NaN" | null
    stickout?: number | "Infinity" | "-Infinity" | "NaN" | null
    notes: string | null
    isPublic: boolean
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
    owner: {
      id: string
      name: string | null
      email: string | null
      image: string | null
    } | null
  }>
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

Resposta de exemplo capturado · 200

OBTER /api/library/tools

{
  "data": []
}

Exemplo de SDK

library.tools

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.library.tools()

curl

OBTER /api/library/tools

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

Experimente

Esquemas

Esquemas nomeados acessíveis a partir dos parâmetros, corpos e respostas deste grupo. UM ? marca um campo opcional; | null marca um campo que pode estar presente com um valor nulo.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

ForbiddenEncoded

{
  _tag: "Forbidden"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

KeyedInternalEncoded

{
  _tag: "KeyedInternal"
  error: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Chamando este grupo

Os IDs de operação têm o formato library.<name>. O Promise SDK gerado (@cadcamfun/api/sdk) expõe a maioria deles como client.<namespace>.<method>(input), onde input é um objeto plano de parâmetros de caminho e campos de corpo; o exemplo do SDK de cada cartão mostra o acessador e o tipo de entrada exatos. Multipart uploads, respostas binárias ou JavaScript e webhooks brutos não são gerados; essas cartas mostram fetch em vez disso.

Erros do 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
  }
}

Solução de problemas

Sintoma	Causa provável	Consertar
401 em cada chamada	Token de um lançamento anterior ou ausente `Bearer` prefixo	Enviar `Authorization: Bearer <token>` com o token com o qual o sidecar foi iniciado.
400 antes que algo aconteça	O corpo ou parâmetro não corresponde ao esquema	Compare a carga útil com o esquema de solicitação no cartão.
403 ou 404 em um registro que você vê em outro lugar	A conta atuante difere	Envie o certo `x-session-token`ou use o perfil local que possui o registro.
409	Estado conflitante, como um nome duplicado ou um cabeçalho de ramificação obsoleto	Leia novamente o recurso e tente novamente com os dados atuais.
Tente dizer "bloqueado pelo CORS"	Os documentos são veiculados a partir de uma origem sem loopback	Execute os documentos localmente ou copie a solicitação como curl.
Ligação recusada	O sidecar foi reiniciado em uma nova porta	Leia a porta do novo `ready` linha.