पालतू जानवर एपीआई फ़ंक्शन

इन API फ़ंक्शंस के साथ, आप अपने स्टोर के डेटाबेस में पालतू जानवरों का प्रबंधन कर सकते हैं।

एक नया पालतू जानवर जोड़ना

स्टोर के डेटाबेस में एक नया पालतू जानवर जोड़ता है।

एंडपॉइंट: https://petstore3.swagger.io/api/v3/pet

ऑपरेशन: POST

उदाहरण

एपीआई कुंजी

POST "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <YOUR_API_KEY>" \
-d '{
  "id": 0,
  "name": "string",
  "category": {
    "id": 0,
    "name": "string"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}'

OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
-d '{
  "id": 0,
  "name": "string",
  "category": {
    "id": 0,
    "name": "string"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}'

प्रतिक्रियाएँ

कोड	विवरण
200	सफल ऑपरेशन
400	अमान्य इनपुट
404	पालतू नहीं मिला
422	सत्यापन अपवाद
डिफ़ॉल्ट	अप्रत्याशित त्रुटि

प्रतिक्रिया का उदाहरण

200: सफल ऑपरेशन

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

पैरामीटर

अनुरोध बॉडी

नाम	प्रकार	विवरण
बॉडी	पेट ऑब्जेक्ट	(आवश्यक) स्टोर में जोड़ने के लिए Pet ऑब्जेक्ट।

मौजूदा पालतू जानवर को अपडेट करना

मौजूदा पालतू जानवर को उसकी आईडी (ID) से अपडेट करता है।

एंडपॉइंट: https://petstore3.swagger.io/api/v3/pet

ऑपरेशन: PUT

उदाहरण

एपीआई कुंजी

PUT "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <YOUR_API_KEY>" \
-d '{
    "id": 210,
    "name": "Krypto",
    "status": "available"
  }'

OAuth 2.0

PUT "https://petstore3.swagger.io/api/v3/pet" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
-d '{
    "id": 210,
    "name": "Krypto",
    "status": "available"
  }'

प्रतिक्रियाएँ

कोड	विवरण
200	सफल ऑपरेशन
400	अमान्य इनपुट
404	पालतू नहीं मिला
422	सत्यापन अपवाद
डिफ़ॉल्ट	अप्रत्याशित त्रुटि

प्रतिक्रिया का उदाहरण

200: सफल ऑपरेशन

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

पैरामीटर

अनुरोध बॉडी

नाम	प्रकार	विवरण
बॉडी	पालतू ऑब्जेक्ट	(आवश्यक) अपडेट किए जाने वाले पालतू ऑब्जेक्ट।

स्थिति के अनुसार पालतू जानवर खोजना

उनकी स्थिति के अनुसार पालतू जानवरों को खोजता है।

एंडपॉइंट: https://petstore3.swagger.io/api/v3/pet/findByStatus

ऑपरेशन: GET

उदाहरण

एपीआई कुंजी

GET "https://petstore3.swagger.io/api/v3/pet/findByStatus?status=available" \
-H "accept: application/json" \
-H "api_key: <YOUR_API_KEY>"

OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/pet/findByStatus?status=available" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"

प्रतिक्रियाएँ

कोड	विवरण
200	सफल ऑपरेशन
400	अमान्य इनपुट
डिफ़ॉल्ट	अप्रत्याशित त्रुटि

प्रतिक्रिया का उदाहरण

200: सफल ऑपरेशन

[
  {
    "id": 210,
    "name": "Krypto",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "string"
    ],
    "tags": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "status": "available"
  }
]

पैरामीटर

क्वेरी पैरामीटर

नाम	प्रकार	विवरण
status	string	खोजने वाले पालतू जानवर की स्थिति। डिफ़ॉल्ट: available. अनुमत मान: available, pending, sold.

टैग के अनुसार पालतू जानवर खोजना

उनके टैग के अनुसार पालतू जानवर खोजता है।

एंडपॉइंट: https://petstore3.swagger.io/api/v3/pet/findByTags

ऑपरेशन: GET

उदाहरण

एपीआई कुंजी

GET "https://petstore3.swagger.io/api/v3/pet/findByTags?tags=string" \
-H "accept: application/json" \
-H "api_key: <YOUR_API_KEY>"

OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/pet/findByTags?tags=string" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"

प्रतिक्रियाएँ

कोड	विवरण
200	सफल ऑपरेशन
400	अमान्य इनपुट
डिफ़ॉल्ट	अप्रत्याशित त्रुटि

प्रतिक्रिया का उदाहरण

200: सफल ऑपरेशन

[
  {
    "id": 210,
    "name": "Krypto",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "string"
    ],
    "tags": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "status": "available"
  }
]

पैरामीटर

क्वेरी पैरामीटर

नाम	प्रकार	विवरण
tags	array	फ़िल्टर करने के लिए टैग। डिफ़ॉल्ट: []. अनुमत मान: कोई भी मान्य टैग नाम।

आईडी से पालतू जानवर खोजना

किसी पालतू जानवर को उसकी अद्वितीय आईडी से खोजता है।

एंडपॉइंट: https://petstore3.swagger.io/api/v3/pet/{petId}

ऑपरेशन: GET

उदाहरण

एपीआई कुंजी

GET "https://petstore3.swagger.io/api/v3/pet/210" \
-H "accept: application/json" \
-H "api_key: <YOUR_API_KEY>"

OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/pet/210" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"

प्रतिक्रियाएँ

कोड	विवरण
200	सफल ऑपरेशन
400	गलत आईडी दी गई
404	पालतू जानवर नहीं मिला
डिफ़ॉल्ट	अप्रत्याशित त्रुटि

प्रतिक्रिया का उदाहरण

200: सफल ऑपरेशन

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

पैरामीटर

पथ पैरामीटर

नाम	प्रकार	विवरण
petId	integer	लौटाए जाने वाले पालतू जानवर की ID

फ़ॉर्म डेटा के साथ एक पालतू जानवर को अपडेट करना

स्टोर में फ़ॉर्म डेटा के साथ एक पालतू जानवर को अपडेट करता है।

एंडपॉइंट: https://petstore3.swagger.io/api/v3/pet/{petId}

ऑपरेशन: POST

उदाहरण

एपीआई कुंजी

POST "https://petstore3.swagger.io/api/v3/pet/210" \
-H "api_key: <YOUR_API_KEY>" \
-H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "name=Krypto" \
--data-urlencode "status=available"

OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/pet/210" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
-H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "name=Krypto" \
--data-urlencode "status=available"

प्रतिक्रियाएँ

कोड	विवरण
200	सफल ऑपरेशन
405	अमान्य इनपुट
डिफ़ॉल्ट	अप्रत्याशित त्रुटि

प्रतिक्रिया का उदाहरण

200: सफल ऑपरेशन

{
  "id": 210,
  "name": "Krypto",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "string"
  ],
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "status": "available"
}

पैरामीटर

पथ पैरामीटर

नाम	प्रकार	विवरण
petId	integer	अपडेट किए जाने वाले पालतू जानवर की आईडी

क्वेरी पैरामीटर

नाम	प्रकार	विवरण
name	string	अपडेट किए जाने वाले पालतू जानवर का नाम
status	string	अपडेट किए जाने वाले पालतू जानवर की स्थिति

पालतू जानवर को हटाना

डेटाबेस से एक पालतू जानवर को हटाता है।

एंडपॉइंट: https://petstore3.swagger.io/api/v3/pet/{petId}

ऑपरेशन: DELETE

उदाहरण

एपीआई कुंजी

DELETE "https://petstore3.swagger.io/api/v3/pet/210" \
-H "api_key: <YOUR_API_KEY>"

OAuth 2.0

DELETE "https://petstore3.swagger.io/api/v3/pet/210" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"

प्रतिक्रियाएँ

कोड	विवरण
200	पालतू जानवर हटा दिया गया
400	अमान्य आईडी प्रदान की गई
404	पालतू जानवर नहीं मिला

(एक सफल हटाने पर कोई प्रतिक्रिया बॉडी के साथ 200 कोड लौटाता है।)

पैरामीटर

पथ पैरामीटर

नाम	प्रकार	विवरण
petId	integer	हटाने के लिए पालतू जानवर की आईडी

एक छवि अपलोड करना

किसी पालतू जानवर के लिए एक छवि अपलोड करता है।

एंडपॉइंट: https://petstore3.swagger.io/api/v3/pet/{petId}/uploadImage

ऑपरेशन: POST

उदाहरण

एपीआई कुंजी

POST "https://petstore3.swagger.io/api/v3/pet/210/uploadImage" \
-H "accept: application/json" \
-H "Content-Type: multipart/form-data" \
-H "api_key: <YOUR_API_KEY>" \
--form "file=@/path/to/your/file"

OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/pet/210/uploadImage" \
-H "accept: application/json" \
-H "Content-Type: multipart/form-data" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
--form "file=@/path/to/your/file"

प्रतिक्रियाएँ

कोड	विवरण
200	सफल ऑपरेशन
डिफ़ॉल्ट	अप्रत्याशित त्रुटि

प्रतिक्रिया के उदाहरण

200: सफल ऑपरेशन

{
  "code": 200,
  "type": "unknown",
  "message": "additional data"
}

पैरामीटर

पथ पैरामीटर

नाम	प्रकार	विवरण
petId	integer	अपडेट किए जाने वाले पालतू जानवर की आईडी

फ़ॉर्म डेटा पैरामीटर

नाम	प्रकार	विवरण
additionalMetadata	string	सर्वर को पास करने के लिए अतिरिक्त डेटा।
file	file	अपलोड करने के लिए फ़ाइल।