Documentation

Bibliothèque

Enregistrements de bibliothèque partagés et collections de recherche de composants, de matériaux et d'outils.

Traduit automatiquement de l'anglais. Voir l'original en anglais

Playground

Envoyez ces demandes à votre propre sidecar en cours d’exécution. Les valeurs restent dans ce navigateur.

Non connecté

URL de base Jeton du porteur facultatif Jeton de session facultatif

Comment ça marche

Le sidecar écoute sur un port de bouclage choisi au démarrage et l'imprime dans son ready doubler; utilisez cette URL et le CADCAMFUN_TOKEN ça a commencé avec. Les demandes vont directement de cette page à cette adresse.

Le sidecar envoie les en-têtes CORS uniquement aux origines Tauri et à http://localhost ou http://127.0.0.1 sur n'importe quel port. À partir des documents hébergés, le navigateur bloque la réponse, exécutez donc les documents localement (bun run dev dans packages/web) pour utiliser le terrain de jeu, ou copiez la requête sous forme curl. Pour expérimenter sans toucher aux données réelles, démarrez le sidecar avec CADCAMFUN_DATA_DIR pointé vers un répertoire jetable — voir la procédure pas à pas de l'API.

Opérations

8 endpoints dans le library groupe, généré à partir du propre sidecar Document OpenAPI. Les opérations protégées prennent Authorization: Bearer $CADCAMFUN_TOKEN; voir authentification. Le comportement et les limites sont en place le guide du sous-système.

obtenir	/api/library	library.list
poste	/api/library	library.create
obtenir	/api/library/{id}	library.get
mettre	/api/library/{id}	library.update
supprimer	/api/library/{id}	library.remove
obtenir	/api/library/components	library.components
obtenir	/api/library/materials	library.materials
obtenir	/api/library/tools	library.tools

Opérations de bibliothèque en 3D Faites glisser vers l'orbite · faites défiler pour zoomer · faites glisser vers la droite pour effectuer un panoramique

Un bloc par opération (8), empilé par section de ressources de cette page et coloré par méthode : vert GET, orange POST, bleu PUT, violet PATCH, rouge DELETE. Généré à partir du document OpenAPI au moment de la construction.

/api/library

obtenir /api/library # library.list

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
catégorie	requête	chaîne \| null	facultatif
taper	requête	chaîne \| null	facultatif
recherche	requête	chaîne \| null	facultatif

Réponses

200 Tableau<objet> 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

Exemple de réponse capturé · 200

GET /api/bibliothèque

[]

Exemple 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/bibliothèque

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

Essayez-le

catégorie requête taper requête recherche requête

poste /api/library # library.create

Nécessite Authorization: Bearer <token>.

Corps de la requête · requis · application/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
}

Réponses

201 objet 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

Exemple 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/bibliothèque

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

Essayez-le

Corps de la demande application/json

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

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
identifiant	chemin	chaîne	requis

Réponses

200 objet 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

Exemple 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}"

Essayez-le

identifiant chemin · obligatoire

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

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
identifiant	chemin	chaîne	requis

Corps de la requête · requis · application/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
}

Réponses

200 objet 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

Exemple 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

Essayez-le

identifiant chemin · obligatoire

Corps de la demande application/json

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

Nécessite Authorization: Bearer <token>.

Paramètres

Nom	Dans	Taper	Requis
identifiant	chemin	chaîne	requis

Réponses

200 objet 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

Exemple 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

SUPPRIMER /api/library/{id}

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

Essayez-le

identifiant chemin · obligatoire

/api/library/components

obtenir /api/library/components # library.components

Nécessite Authorization: Bearer <token>.

Réponses

200 objet 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

Exemple de réponse capturé · 200

GET /api/library/components

{
  "data": []
}

Exemple 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/components

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

Essayez-le

/api/library/materials

obtenir /api/library/materials # library.materials

Nécessite Authorization: Bearer <token>.

Réponses

200 objet 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

Exemple de réponse capturé · 200

OBTENIR /api/bibliothèque/matériaux

{
  "data": []
}

Exemple 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

OBTENIR /api/bibliothèque/matériaux

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

Essayez-le

/api/library/tools

obtenir /api/library/tools # library.tools

Nécessite Authorization: Bearer <token>.

Réponses

200 objet 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

Exemple de réponse capturé · 200

GET /api/bibliothèque/outils

{
  "data": []
}

Exemple 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

GET /api/bibliothèque/outils

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

Essayez-le

Schémas

Schémas nommés accessibles à partir des paramètres, des corps et des réponses de ce groupe. UN ? marque un champ facultatif ; | null marque un champ qui peut être présent avec une valeur nulle.

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
}

Appel à ce groupe

Les identifiants d'opération ont la forme library.<name>. Le SDK Promise généré (@cadcamfun/api/sdk) expose la plupart d'entre eux comme client.<namespace>.<method>(input), où input est un objet plat composé de paramètres de chemin et de champs de corps ; L'exemple de SDK de chaque carte montre l'accesseur exact et le type d'entrée. Les téléchargements en plusieurs parties, les réponses binaires ou JavaScript et les webhooks bruts ne sont pas générés ; ces cartes montrent fetch à la place.

Erreurs du SDK Promise

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

Dépannage

Symptôme	Cause probable	Réparer
401 à chaque appel	Jeton d'un lancement précédent, ou manquant `Bearer` préfixe	Envoyer `Authorization: Bearer <token>` avec le jeton avec lequel le sidecar a été démarré.
400 avant que quoi que ce soit se produise	Le corps ou le paramètre ne correspond pas au schéma	Comparez la charge utile avec le schéma de demande sur la carte.
403 ou 404 sur un enregistrement visible ailleurs	Le compte intérimaire diffère	Envoyez le droit `x-session-token`, ou utilisez le profil local propriétaire de l'enregistrement.
409	État conflictuel, tel qu'un nom en double ou un chef de succursale obsolète	Relisez la ressource et réessayez avec les données actuelles.
Essayez, il est écrit "bloqué par CORS"	Les documents sont servis à partir d'une origine sans bouclage	Exécutez la documentation localement ou copiez la demande en tant que curl.
Connexion rejetée	Le sidecar a redémarré sur un nouveau port	Lire le port du nouveau `ready` ligne.