وظائف واجهة برمجة تطبيقات المستخدم

يصف هذا القسم العمليات المتعلقة بالمستخدمين.

إنشاء مستخدم

إنشاء حساب مستخدم جديد.

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

العملية: POST

أمثلة

API Key

POST "https://petstore3.swagger.io/api/v3/user" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <YOUR_API_KEY>" \
-d 
  {
  "id": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}

OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/user" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
-H "Content-Type: application/json" \
-d 
  {
  "id": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}

الردود

| الرمز | الوصف | | default | عملية ناجحة |

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

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

{
  "id": 10,
  "username": "theUser",
  "firstName": "John",
  "lastName": "James",
  "email": "john@email.com",
  "password": "12345",
  "phone": "12345",
  "userStatus": 1
}

المعلمات

جسم الطلب

الاسم	النوع	الوصف
body	كائن المستخدم	(Required) كائن User المطلوب إنشاؤه.

إنشاء قائمة بالمستخدمين مع قائمة

إنشاء قائمة مستخدمين بقائمة إدخال معينة.

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

العملية: POST

أمثلة

أمثلة

API Key

POST "https://petstore3.swagger.io/api/v3/user/createWithList" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <YOUR_API_KEY>" \
-d \
  [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "password": "string",
      "phone": "string",
      "userStatus": 0
    }
  ]

OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/user/createWithList" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
-d \
  [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "password": "string",
      "phone": "string",
      "userStatus": 0
    }
  ]

الردود

| الرمز | الوصف | | default | عملية ناجحة |

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

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

{
  "id": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}

المعلمات

جسم الطلب

الاسم	النوع	الوصف
body	مصفوفة كائنات المستخدم	(Required) قائمة كائنات User المطلوب إنشاؤها.

تسجيل الدخول

تسجيل دخول المستخدم إلى النظام.

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

العملية: GET

أمثلة

API Key

GET "https://petstore3.swagger.io/api/v3/user/login?username=string&password=string" \
-H "accept: application/json" \
-H "api_key: <YOUR_API_KEY>"

OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/user/login?username=string&password=string" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"

الردود

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

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

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

{
  "message": "logged in user session:abcdef12345"
}

Headers:

الاسم	الوصف	النوع
X-Rate-Limit	المكالمات في الساعة المسموح بها من قبل المستخدم.	integer
X-Expires-After	تاريخ انتهاء صلاحية الرمز المميز بالتوقيت العالمي المنسق.	string

المعلمات

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

الاسم	النوع	الوصف
username	string	اسم المستخدم لتسجيل الدخول.
password	string	كلمة المرور لتسجيل الدخول بنص واضح.

تسجيل الخروج

يقوم بتسجيل الخروج من جلسة عمل المستخدم الحالي الذي قام بتسجيل الدخول.

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

العملية: GET

أمثلة

API Key

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

OAuth 2.0

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

الردود

الرمز	الوصف
200	عملية ناجحة
default	عملية ناجحة

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

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

{
  "message": "Successfully logged out"
}

المعلمات

لا يوجد

الحصول على مستخدم حسب اسم المستخدم

الحصول على مستخدم حسب اسم المستخدم الخاص به.

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

العملية: GET

أمثلة

API Key

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

OAuth 2.0

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

الردود

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

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

{
  "id": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}

المعلمات

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

الاسم	النوع	الوصف
username	string	اسم المستخدم المطلوب جلبه. استخدم "user" للاختبار.

تحديث مستخدم

تحديث مستخدم.

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

العملية: PUT

أمثلة

API Key

PUT "https://petstore3.swagger.io/api/v3/user/user1" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <YOUR_API_KEY>" \
-d 
  {
  "id": 0,
  "username": "user1",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}

OAuth 2.0

PUT "https://petstore3.swagger.io/api/v3/user/user1" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
-d 
  {
  "id": 0,
  "username": "user1",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}

الردود

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

(يُرجع التحديث الناجح الرمز 200 بدون نص استجابة).

المعلمات

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

الاسم	النوع	الوصف
username	string	اسم المستخدم المراد تحديثه

جسم الطلب

الاسم	النوع	الوصف
body	كائن المستخدم	(Required) كائن User مع المعلومات المحدثة.

حذف مستخدم

حذف مستخدم.

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

العملية: DELETE

أمثلة

API Key

DELETE "https://petstore3.swagger.io/api/v3/user/user1" \
-H "accept: application/json" \
-H "api_key: <YOUR_API_KEY>"

OAuth 2.0

DELETE "https://petstore3.swagger.io/api/v3/user/user1" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"

الردود

الرمز	الوصف
200	تم حذف المستخدم
400	تم توفير اسم مستخدم غير صالح
404	المستخدم غير موجود

(يؤدي الحذف الناجح إلى إرجاع الرمز 200 بدون نص استجابة).

المعلمات

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

الاسم	النوع	الوصف
username	string	اسم المستخدم المراد حذفه