Documentazione

Progetti

Crea, elenca, leggi, aggiorna e rimuovi progetti con controlli di accesso del proprietario e dell'organizzazione.

Tradotto automaticamente dall'inglese. Vedi l'originale in inglese

Playground

Invia queste richieste al tuo sidecar in corsa. I valori rimangono in questo browser.

Non connesso

URL di base Gettone al portatore opzionale Token di sessione opzionale

Come funziona

Il sidecar resta in ascolto su una porta di loopback scelta all'avvio e la stampa nel suo file ready linea; usa quell'URL e il file CADCAMFUN_TOKEN è stato iniziato con. Le richieste vanno direttamente da questa pagina a quell'indirizzo.

Il sidecar invia intestazioni CORS solo alle origini Tauri e a http://localhost o http://127.0.0.1 su qualsiasi porto. Dai documenti ospitati il browser blocca la risposta, quindi esegui i documenti localmente (bun run dev in packages/web) per utilizzare il parco giochi, oppure copiare la richiesta come ricciolo. Per sperimentare senza toccare i dati reali, avvia il sidecar con CADCAMFUN_DATA_DIR indicato in una directory usa e getta - vedi la procedura dettagliata dell'API.

Operazioni

5 endpoint nel projects gruppo, generato da quello del sidecar Documento OpenAPI. Le operazioni protette richiedono Authorization: Bearer $CADCAMFUN_TOKEN; vedere autenticazione. Comportamenti e limiti sono entrati la guida del sottosistema.

ottenere	/api/projects	projects.list
inviare	/api/projects	projects.create
ottenere	/api/projects/{id}	projects.get
mettere	/api/projects/{id}	projects.update
eliminare	/api/projects/{id}	projects.remove

Operazioni sui progetti in 3D Trascina per orbitare · scorri per ingrandire · trascina con il tasto destro per eseguire la panoramica

Un blocco per operazione (5), impilato per sezione di risorse di questa pagina e colorato in base al metodo: verde GET, arancione POST, blu PUT, viola PATCH, rosso DELETE. Generato dal documento OpenAPI in fase di compilazione.

/api/projects

ottenere /api/projects # projects.list

Richiede Authorization: Bearer <token>.

Risposte

200 Matrice<oggetto> application/json

Array<{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  ownerId: string
  organizationId: string | null
  isPublic: boolean
  owner: {
    id: string
    name: string | null
    email: string | null
  }
  organization: {
    id: string
    name: string
  } | null
  _count: {
    drawings: number | "Infinity" | "-Infinity" | "NaN"
    components: number | "Infinity" | "-Infinity" | "NaN"
  }
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Risposta di esempio catturato · 200

GET /api/projects

[]

Esempio dell'SDK

projects.list

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.projects.list()

curl

GET /api/projects

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

Provalo

inviare /api/projects # projects.create

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

{
  name?: string | null
  description?: string | null
  organizationId?: string | null
  isPublic?: boolean | null
}

Risposte

201 oggetto application/json

{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  ownerId: string
  organizationId: string | null
  isPublic: boolean
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

projects.create

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

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

// ProjectsCreateInput
const result = await client.projects.create({
  name: "",
  description: "",
  organizationId: "",
  isPublic: false
})

curl

POST /api/progetti

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

Provalo

Richiedi corpo application/json

ottenere /api/projects/{id} # projects.get

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Risposte

200 oggetto application/json

{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  ownerId: string
  organizationId: string | null
  isPublic: boolean
  owner: {
    id: string
    name: string | null
    email: string | null
  }
  organization: {
    id: string
    name: string
  } | null
  _count: {
    drawings: number | "Infinity" | "-Infinity" | "NaN"
    components: number | "Infinity" | "-Infinity" | "NaN"
  }
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

projects.get

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

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

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

curl

GET /api/projects/{id}

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

Provalo

id percorso · richiesto

mettere /api/projects/{id} # projects.update

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Corpo della richiesta · obbligatorio · application/json

{
  name?: string | null
  description?: string | null
  organizationId?: string | null
  isPublic?: boolean | null
}

Risposte

200 oggetto application/json

{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  ownerId: string
  organizationId: string | null
  isPublic: boolean
  owner: {
    id: string
    name: string | null
    email: string | null
  }
  organization: {
    id: string
    name: string
  } | null
  _count: {
    drawings: number | "Infinity" | "-Infinity" | "NaN"
    components: number | "Infinity" | "-Infinity" | "NaN"
  }
}

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

Esempio dell'SDK

projects.update

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

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

// ProjectsUpdateInput
const result = await client.projects.update({
  id: "<id>",
  name: "",
  description: "",
  organizationId: "",
  isPublic: false
})

curl

PUT /api/projects/{id}

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

Provalo

id percorso · richiesto

Richiedi corpo application/json

eliminare /api/projects/{id} # projects.remove

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Risposte

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

Esempio dell'SDK

projects.remove

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

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

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

curl

ELIMINA /api/projects/{id}

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

Provalo

id percorso · richiesto

Schemi

Schemi denominati raggiungibili dai parametri, dai corpi e dalle risposte di questo gruppo. UN ? contrassegna un campo facoltativo; | null contrassegna un campo che può essere presente con un valore nullo.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

ForbiddenEncoded

{
  _tag: "Forbidden"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Chiamando questo gruppo

Gli ID operazione hanno il formato projects.<name>. L'SDK Promise generato (@cadcamfun/api/sdk) ne espone la maggior parte come client.<namespace>.<method>(input), dove input è un oggetto piatto di parametri di percorso e campi del corpo; l'esempio dell'SDK di ciascuna scheda mostra l'esatto accessor e il tipo di input. Non vengono generati caricamenti in più parti, risposte binarie o JavaScript e webhook grezzi; quelle carte mostrano fetch invece.

Errori dall'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
  }
}

Risoluzione dei problemi

Sintomo	Probabile causa	Aggiustare
401 a ogni chiamata	Token di un lancio precedente o mancante `Bearer` prefisso	Inviare `Authorization: Bearer <token>` con il gettone con cui è stato avviato il sidecar.
400 prima che accada qualcosa	Il corpo o il parametro non corrisponde allo schema	Confronta il payload con lo schema di richiesta sulla carta.
403 o 404 su un record visibile altrove	Il resoconto della recitazione è diverso	Invia il diritto `x-session-token`oppure utilizzare il profilo locale proprietario del record.
409	Stato in conflitto, ad esempio un nome duplicato o una testa di ramo obsoleta	Rileggere la risorsa e riprovare con i dati correnti.
Prova, dice "bloccato da CORS"	I documenti vengono serviti da un'origine non di loopback	Esegui i documenti localmente o copia la richiesta come curl.
Connessione rifiutata	Il sidecar è ripartito su una nuova porta	Leggi il porto dal nuovo `ready` riga.