وظائف واجهة برمجة تطبيقات الحيوانات الأليفة

باستخدام وظائف واجهة برمجة التطبيقات هذه، يمكنك إدارة الحيوانات الأليفة في قاعدة بيانات متجرك.

إضافة حيوان أليف جديد

إضافة حيوان أليف جديد إلى قاعدة بيانات المتجر.

نقطة النهاية: https://petstore3.swagger.io/api/v3/pet

العملية: POST

أمثلة

API Key
OAuth 2.0

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

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	استثناء التحقق من الصحة
default	خطأ غير متوقع

مثال على الاستجابة

200: عملية ناجحة

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

المعلمات

هيئة الطلب

الاسم	النوع	الوصف
الجسم	كائن حيوان أليف	(مطلوب) كائن `Pet` المراد إضافته إلى المخزن.

تحديث حيوان أليف موجود

تحديث حيوان أليف موجود بمعرفه.

نقطة النهاية: https://petstore3.swagger.io/api/v3/pet

العملية: PUT

أمثلة

API Key
OAuth 2.0

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

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	استثناء التحقق من الصحة
default	خطأ غير متوقع

مثال على الاستجابة

200: عملية ناجحة

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

المعلمات

هيئة الطلب

الاسم	النوع	الوصف
الجسم	كائن حيوان أليف	(مطلوب) كائن Pet لتحديثه.

العثور على حيوان أليف حسب الحالة

البحث عن حيوانات أليفة حسب حالتها.

نقطة النهاية: https://petstore3.swagger.io/api/v3/pet/findByStatus

العملية: GET

أمثلة

API Key
OAuth 2.0

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

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

الردود

الرمز	الوصف
200	عملية ناجحة
400	إدخال غير صالح
default	خطأ غير متوقع

مثال على الاستجابة

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

أمثلة

API Key
OAuth 2.0

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

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

الردود

الرمز	الوصف
200	عملية ناجحة
400	إدخال غير صالح
default	خطأ غير متوقع

مثال على الاستجابة

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

أمثلة

API Key
OAuth 2.0

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

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

الردود

الرمز	الوصف
200	عملية ناجحة
400	تم توفير معرف غير صالح
404	لم يتم العثور على الحيوان الأليف
default	خطأ غير متوقع

مثال على الاستجابة

200: عملية ناجحة

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

المعلمات

معلمات المسار

الاسم	النوع	الوصف
petId	integer	معرف الحيوان الأليف المراد إرجاعه

تحديث حيوان أليف ببيانات النموذج

تحديث حيوان أليف في المتجر ببيانات النموذج.

نقطة النهاية: https://petstore3.swagger.io/api/v3/pet/{petId}

العملية: POST

أمثلة

API Key
OAuth 2.0

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"

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	إدخال غير صالح
default	خطأ غير متوقع

مثال على الاستجابة

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

أمثلة

API Key
OAuth 2.0

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

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

أمثلة

API Key
OAuth 2.0

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"

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	عملية ناجحة
default	خطأ غير متوقع

أمثلة على الاستجابة

200: عملية ناجحة

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

المعلمات

معلمات المسار

الاسم	النوع	الوصف
petId	integer	معرف الحيوان الأليف المراد تحديثه

معلمات بيانات النموذج

الاسم	النوع	الوصف
additionalMetadata	string	بيانات إضافية لتمريرها إلى الخادم.
file	file	ملف للتحميل.

إضافة حيوان أليف جديد​

أمثلة​

الردود​

مثال على الاستجابة​

المعلمات​

هيئة الطلب​

تحديث حيوان أليف موجود​

أمثلة​

الردود​

مثال على الاستجابة​

المعلمات​

هيئة الطلب​

العثور على حيوان أليف حسب الحالة​

أمثلة​

الردود​

مثال على الاستجابة​

المعلمات​

معلمات الاستعلام​

العثور على الحيوانات الأليفة حسب العلامة​

أمثلة​

الردود​

مثال على الاستجابة​

المعلمات​

معلمات الاستعلام​

البحث عن حيوان أليف حسب المعرف​

أمثلة​

الردود​

مثال على الاستجابة​

المعلمات​

معلمات المسار​

تحديث حيوان أليف ببيانات النموذج​

أمثلة​

الردود​

مثال على الاستجابة​

المعلمات​

معلمات المسار​

معلمات الاستعلام​

حذف حيوان أليف​

أمثلة​

الردود​

المعلمات​

معلمات المسار​

تحميل صورة​

أمثلة​

الردود​

أمثلة على الاستجابة​

المعلمات​

معلمات المسار​

معلمات بيانات النموذج​

إضافة حيوان أليف جديد

أمثلة

الردود

مثال على الاستجابة

المعلمات

هيئة الطلب

تحديث حيوان أليف موجود

أمثلة

الردود

مثال على الاستجابة

المعلمات

هيئة الطلب

العثور على حيوان أليف حسب الحالة

أمثلة

الردود

مثال على الاستجابة

المعلمات

معلمات الاستعلام

العثور على الحيوانات الأليفة حسب العلامة

أمثلة

الردود

مثال على الاستجابة

المعلمات

معلمات الاستعلام

البحث عن حيوان أليف حسب المعرف

أمثلة

الردود

مثال على الاستجابة

المعلمات

معلمات المسار

تحديث حيوان أليف ببيانات النموذج

أمثلة

الردود

مثال على الاستجابة

المعلمات

معلمات المسار

معلمات الاستعلام

حذف حيوان أليف

أمثلة

الردود

المعلمات

معلمات المسار

تحميل صورة

أمثلة

الردود

أمثلة على الاستجابة

المعلمات

معلمات المسار

معلمات بيانات النموذج