दस्तावेज़

परियोजनाओं

स्वामी और संगठन पहुंच जांच के साथ प्रोजेक्ट बनाएं, सूचीबद्ध करें, पढ़ें, अपडेट करें और हटाएं।

स्वचालित अनुवाद अभी उपलब्ध नहीं है; पाठ अंग्रेज़ी में है और इंटरफ़ेस आपकी भाषा में है। अंग्रेज़ी मूल देखें

प्लेग्राउंड

इन अनुरोधों को अपने स्वयं के चल रहे साइडकार को भेजें। मान इस ब्राउज़र में रहते हैं.

जुड़े नहीं हैं

आधार यूआरएल वाहक टोकन वैकल्पिक सत्र टोकन वैकल्पिक

यह कैसे काम करता है

साइडकार स्टार्टअप पर चुने गए लूपबैक पोर्ट पर सुनता है और इसे प्रिंट करता है ready रेखा; उस यूआरएल का उपयोग करें और CADCAMFUN_TOKEN इसकी शुरुआत की गई थी. अनुरोध सीधे इस पृष्ठ से उस पते पर जाते हैं।

साइडकार CORS हेडर को केवल टौरी मूल और तक भेजता है http://localhost या http://127.0.0.1 किसी भी बंदरगाह पर. होस्ट किए गए दस्तावेज़ों से ब्राउज़र प्रतिक्रिया को अवरुद्ध कर देता है, इसलिए दस्तावेज़ों को स्थानीय रूप से चलाएँ (bun run dev में packages/web) खेल के मैदान का उपयोग करने के लिए, या अनुरोध को कर्ल के रूप में कॉपी करें। वास्तविक डेटा को छुए बिना प्रयोग करने के लिए, साइडकार से शुरुआत करें CADCAMFUN_DATA_DIR एक बेकार निर्देशिका की ओर इशारा किया - देखें एपीआई वॉकथ्रू.

संचालन

5 एंडपॉइंट projects समूह, साइडकार के स्वयं से उत्पन्न ओपनएपीआई दस्तावेज़. संरक्षित संचालन लेते हैं Authorization: Bearer $CADCAMFUN_TOKEN; देखना प्रमाणीकरण. व्यवहार और मर्यादा में हैं सबसिस्टम गाइड.

पाना	/api/projects	projects.list
डाक	/api/projects	projects.create
पाना	/api/projects/{id}	projects.get
रखना	/api/projects/{id}	projects.update
मिटाना	/api/projects/{id}	projects.remove

3डी में परियोजना संचालन कक्षा में खींचें · ज़ूम करने के लिए स्क्रॉल करें · पैन करने के लिए दाईं ओर खींचें

इस इंटरैक्टिव 3डी उदाहरण को देखने के लिए जावास्क्रिप्ट सक्षम करें।

प्रति ऑपरेशन एक ब्लॉक (5), इस पृष्ठ के प्रति संसाधन अनुभाग को स्टैक्ड किया गया है और विधि के अनुसार रंगा गया है: हरा GET, नारंगी POST, नीला PUT, बैंगनी PATCH, लाल DELETE। निर्माण के समय OpenAPI दस्तावेज़ से उत्पन्न।

/api/projects

पाना /api/projects # projects.list

आवश्यक है Authorization: Bearer <token>.

जवाब

200 सारणी<ऑब्जेक्ट> 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

उदाहरण प्रतिक्रिया कब्जा कर लिया गया · 200

/एपीआई/प्रोजेक्ट प्राप्त करें

[]

एसडीके उदाहरण

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

/एपीआई/प्रोजेक्ट प्राप्त करें

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

इसे अजमाएं

डाक /api/projects # projects.create

आवश्यक है Authorization: Bearer <token>.

अनुरोध का मुख्य भाग · आवश्यक · एप्लिकेशन/जेसन

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

जवाब

201 वस्तु 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

एसडीके उदाहरण

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

पोस्ट/एपीआई/प्रोजेक्ट्स

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

इसे अजमाएं

निकाय से अनुरोध करें application/json

पाना /api/projects/{id} # projects.get

आवश्यक है Authorization: Bearer <token>.

पैरामीटर

नाम	में	प्रकार	आवश्यक
पहचान	पथ	डोरी	आवश्यक

जवाब

200 वस्तु 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

एसडीके उदाहरण

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

प्राप्त करें /api/projects/{id}

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

इसे अजमाएं

पहचान पथ · आवश्यक

रखना /api/projects/{id} # projects.update

आवश्यक है Authorization: Bearer <token>.

पैरामीटर

नाम	में	प्रकार	आवश्यक
पहचान	पथ	डोरी	आवश्यक

अनुरोध का मुख्य भाग · आवश्यक · एप्लिकेशन/जेसन

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

जवाब

200 वस्तु 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

एसडीके उदाहरण

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

इसे अजमाएं

पहचान पथ · आवश्यक

निकाय से अनुरोध करें application/json

मिटाना /api/projects/{id} # projects.remove

आवश्यक है Authorization: Bearer <token>.

पैरामीटर

नाम	में	प्रकार	आवश्यक
पहचान	पथ	डोरी	आवश्यक

जवाब

200 वस्तु 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

एसडीके उदाहरण

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

हटाएँ /api/projects/{id}

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

इसे अजमाएं

पहचान पथ · आवश्यक

स्कीमा

नामित स्कीमा इस समूह के मापदंडों, निकायों और प्रतिक्रियाओं से पहुंच योग्य हैं। ए ? एक वैकल्पिक फ़ील्ड चिह्नित करता है; | null उस फ़ील्ड को चिह्नित करता है जो शून्य मान के साथ मौजूद हो सकता है।

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
}

इस समूह को कॉल किया जा रहा है

ऑपरेशन आईडी का फॉर्म है projects.<name>. जनरेट किया गया प्रॉमिस SDK (@cadcamfun/api/sdk) उनमें से अधिकांश को इस रूप में उजागर करता है client.<namespace>.<method>(input), कहाँ input पथ पैरामीटर और बॉडी फ़ील्ड की एक सपाट वस्तु है; प्रत्येक कार्ड का एसडीके उदाहरण सटीक एक्सेसर और इनपुट प्रकार दिखाता है। मल्टीपार्ट अपलोड, बाइनरी या जावास्क्रिप्ट प्रतिक्रियाएँ और कच्चे वेबहुक उत्पन्न नहीं होते हैं; वे कार्ड दिखाते हैं fetch इसके बजाय.

प्रॉमिस एसडीके से त्रुटियाँ

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	विरोधाभासी स्थिति, जैसे डुप्लिकेट नाम या पुराना शाखा प्रमुख	संसाधन को दोबारा पढ़ें और वर्तमान डेटा के साथ पुनः प्रयास करें।
कोशिश करें यह कहता है "सीओआरएस द्वारा अवरुद्ध"	दस्तावेज़ गैर-लूपबैक मूल से परोसे जाते हैं	दस्तावेज़ों को स्थानीय रूप से चलाएँ या अनुरोध को कर्ल के रूप में कॉपी करें।
कनेक्शन नहीं हो सका	साइडकार एक नए बंदरगाह पर फिर से शुरू हुई	नए से पोर्ट पढ़ें `ready` पंक्ति.