الوثائق

تخزين الأدوات

بيانات تخزين الأداة وجمعها أو استيرادها/تصديرها لكل أداة.

مترجم تلقائيًا من الإنجليزية. عرض الأصل بالإنجليزية

ساحة التجربة

أرسل هذه الطلبات إلى السايدكار الخاصة بك. تبقى القيم في هذا المتصفح.

غير متصل

عنوان URL الأساسي رمز حامل خياري رمز الجلسة خياري

كيف يعمل هذا

يستمع السايدكار إلى منفذ الاسترجاع الذي تم اختياره عند بدء التشغيل ويطبعه في منفذ الاسترجاع الخاص به ready خط؛ استخدم عنوان URL هذا و CADCAMFUN_TOKEN لقد بدأ مع. تذهب الطلبات مباشرة من هذه الصفحة إلى هذا العنوان.

يرسل السايدكار رؤوس CORS فقط إلى أصول Tauri وإلى http://localhost أو http://127.0.0.1 على أي منفذ. من المستندات المستضافة، يحظر المتصفح الاستجابة، لذا قم بتشغيل المستندات محليًا (bun run dev في packages/web) لاستخدام الملعب، أو نسخ الطلب كحليقة. للتجربة دون لمس البيانات الحقيقية، ابدأ تشغيل السايدكار باستخدام CADCAMFUN_DATA_DIR أشار إلى دليل مهمل - انظر إرشادات واجهة برمجة التطبيقات.

العمليات

7 نقاط نهاية في toolsStorage المجموعة التي تم إنشاؤها من السايدكار مستند OpenAPI. تأخذ العمليات المحمية Authorization: Bearer $CADCAMFUN_TOKEN; يرى المصادقة. السلوك والحدود موجودة دليل النظام الفرعي.

بريد	/api/tools/{id}/storage	toolsStorage.save
يحصل	/api/tools/{id}/storage	toolsStorage.read
يمسح	/api/tools/{id}/storage	toolsStorage.remove
يحصل	/api/tools/export-import	toolsStorage.export
بريد	/api/tools/export-import	toolsStorage.import
يحصل	/api/tools/{id}/export-import	toolsStorage.exportById
بريد	/api/tools/{id}/export-import	toolsStorage.importById

عمليات تخزين الأدوات في 3د اسحب إلى المدار · قم بالتمرير للتكبير · اسحب بزر الماوس الأيمن للتحريك

كتلة واحدة لكل عملية (7)، مكدسة لكل قسم موارد في هذه الصفحة وملونة حسب الطريقة: GET الأخضر، POST البرتقالي، PUT الأزرق، PATCH البنفسجي، DELETE الأحمر. تم إنشاؤها من مستند OpenAPI في وقت الإنشاء.

/api/tools

بريد /api/tools/{id}/storage # toolsStorage.save

يتطلب Authorization: Bearer <token>.

حدود

اسم	في	يكتب	مطلوب
بطاقة تعريف	طريق	خيط	مطلوب

نص الطلب · مطلوب · application/json

unknown

الردود

200 هدف application/json

{
  success: true
  message: string
  data: unknown | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

مثال SDK

toolsStorage.save

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

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

// ToolsStorageSaveInput
const result = await client.toolsStorage.save({
  id: "<id>"
})

curl

POST /api/tools/{id}/storage

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

جربه

بطاقة تعريف المسار · مطلوب

هيئة الطلب application/json

يحصل /api/tools/{id}/storage # toolsStorage.read

يتطلب Authorization: Bearer <token>.

حدود

اسم	في	يكتب	مطلوب
بطاقة تعريف	طريق	خيط	مطلوب
طريق	استفسار	خيط \| null	خياري
signedUrl	استفسار	خيط \| null	خياري

الردود

200 هدف application/json

{
  success: true
  message: string
  data: unknown | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

مثال SDK

toolsStorage.read

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

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

// ToolsStorageReadInput
const result = await client.toolsStorage.read({
  id: "<id>"
})

curl

احصل على /api/tools/{id}/storage

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

جربه

بطاقة تعريف المسار · مطلوب طريق استفسار signedUrl استفسار

يمسح /api/tools/{id}/storage # toolsStorage.remove

يتطلب Authorization: Bearer <token>.

حدود

اسم	في	يكتب	مطلوب
بطاقة تعريف	طريق	خيط	مطلوب
طريق	استفسار	خيط \| null	خياري

الردود

200 هدف application/json

{
  success: true
  message: string
  data: unknown | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

مثال SDK

toolsStorage.remove

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

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

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

curl

حذف /api/tools/{id}/storage

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

جربه

بطاقة تعريف المسار · مطلوب طريق استفسار

يحصل /api/tools/{id}/export-import # toolsStorage.exportById

يتطلب Authorization: Bearer <token>.

حدود

اسم	في	يكتب	مطلوب
بطاقة تعريف	طريق	خيط	مطلوب
معرفات	استفسار	خيط \| خيط[] \| null	خياري
شكل	استفسار	خيط \| null	خياري

الردود

200 أي قيمة JSON application/json

unknown

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

مثال SDK

toolsStorage.exportById

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

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

// ToolsStorageExportByIdInput
const result = await client.toolsStorage.exportById({
  id: "<id>"
})

curl

احصل على /api/tools/{id}/export-import

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

جربه

بطاقة تعريف المسار · مطلوب معرفات استفسار شكل استفسار

بريد /api/tools/{id}/export-import # toolsStorage.importById

يتطلب Authorization: Bearer <token>.

حدود

اسم	في	يكتب	مطلوب
بطاقة تعريف	طريق	خيط	مطلوب

نص الطلب · مطلوب · application/json

unknown

الردود

200 هدف application/json

{
  success: true
  message: string
  data: unknown | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

مثال SDK

toolsStorage.importById

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

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

// ToolsStorageImportByIdInput
const result = await client.toolsStorage.importById({
  id: "<id>"
})

curl

POST /api/tools/{id}/export-import

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

جربه

بطاقة تعريف المسار · مطلوب

هيئة الطلب application/json

/api/tools/export-import

يحصل /api/tools/export-import # toolsStorage.export

يتطلب Authorization: Bearer <token>.

حدود

اسم	في	يكتب	مطلوب
معرفات	استفسار	خيط \| خيط[] \| null	خياري
شكل	استفسار	خيط \| null	خياري

الردود

200 أي قيمة JSON application/json

unknown

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

رد المثال تم الالتقاط · 404

الحصول على /api/tools/export-import

{
  "_tag": "EnvNotFound",
  "success": false,
  "message": "No accessible tools found",
  "errors": null
}

مثال SDK

toolsStorage.export

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

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

// ToolsStorageExportInput
const result = await client.toolsStorage.export({})

curl

الحصول على /api/tools/export-import

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

جربه

معرفات استفسار شكل استفسار

بريد /api/tools/export-import # toolsStorage.import

يتطلب Authorization: Bearer <token>.

نص الطلب · مطلوب · application/json

unknown

الردود

200 هدف application/json

{
  success: true
  message: string
  data: unknown | null
}

400 EnvBadRequestEncoded application/json

EnvBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 EnvForbiddenEncoded application/json

EnvForbiddenEncoded

404 EnvNotFoundEncoded application/json

EnvNotFoundEncoded

405 EnvMethodNotAllowedEncoded application/json

EnvMethodNotAllowedEncoded

500 EnvInternalEncoded application/json

EnvInternalEncoded

مثال SDK

toolsStorage.import

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

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

// ToolsStorageImportInput
const result = await client.toolsStorage.import({})

curl

POST /api/tools/export-import

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

جربه

هيئة الطلب application/json

المخططات

يمكن الوصول إلى المخططات المسماة من معلمات هذه المجموعة وأجسامها واستجاباتها. أ ? يمثل حقلاً اختياريًا؛ | null يضع علامة على الحقل الذي قد يكون موجودًا بقيمة فارغة.

EnvBadRequestEncoded

{
  _tag: "EnvBadRequest"
  success: false
  message: string
  errors: unknown | null
}

EnvForbiddenEncoded

{
  _tag: "EnvForbidden"
  success: false
  message: string
  errors: unknown | null
}

EnvInternalEncoded

{
  _tag: "EnvInternal"
  success: false
  message: string
  errors: unknown | null
}

EnvMethodNotAllowedEncoded

{
  _tag: "EnvMethodNotAllowed"
  success: false
  message: string
  errors: unknown | null
}

EnvNotFoundEncoded

{
  _tag: "EnvNotFound"
  success: false
  message: string
  errors: unknown | null
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

استدعاء هذه المجموعة

معرفات العملية لها النموذج toolsStorage.<name>. وعد 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"	يتم تقديم المستندات من أصل غير استرجاعي	قم بتشغيل المستندات محليًا أو انسخ الطلب كـ curly.
رفض اتصال	تم إعادة تشغيل السايدكار في منفذ جديد	قراءة المنفذ من الجديد `ready` سطر.