मुख्य कंटेंट तक स्किप करें

यूज़र एपीआई फ़ंक्शंस

यह अनुभाग उपयोगकर्ताओं से संबंधित संचालन का वर्णन करता है।

एक उपयोगकर्ता बनाना​

एक नया उपयोगकर्ता खाता बनाता है।

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

संचालन: POST

उदाहरण​

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

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

कोडविवरण
defaultसफल ऑपरेशन
प्रतिक्रिया उदाहरण​

200: सफल ऑपरेशन

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

पैरामीटर​

अनुरोध बॉडी​
नामप्रकारविवरण
bodyUser object(आवश्यक) बनाने के लिए User ऑब्जेक्ट।

list के साथ उपयोगकर्ताओं की सूची बनाना​

दी गई इनपुट सूची के साथ उपयोगकर्ताओं की सूची बनाता है।

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

ऑपरेशन: POST

उदाहरण​

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

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

कोडविवरण
defaultसफल ऑपरेशन
प्रतिक्रिया का उदाहरण​

200: सफल ऑपरेशन

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

पैरामीटर​

अनुरोध बॉडी​
नामप्रकारविवरण
bodyArray of User objects(आवश्यक) बनाने के लिए User ऑब्जेक्ट्स की सूची।

लॉग इन​

उपयोगकर्ता को सिस्टम में लॉग इन करता है।

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

ऑपरेशन: GET

उदाहरण​

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

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

कोडविवरण
200सफल ऑपरेशन
400गलत उपयोगकर्ता नाम/पासवर्ड प्रदान किया गया
defaultअप्रत्याशित त्रुटि

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

200: सफल ऑपरेशन

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

हेडर:

नामविवरणप्रकार
X-Rate-Limitउपयोगकर्ता द्वारा प्रति घंटे की जाने वाली कॉल।integer
X-Expires-AfterUTC में वह तारीख जब टोकन समाप्त हो जाता है।string

पैरामीटर​

क्वेरी पैरामीटर​
नामप्रकारविवरण
usernamestringलॉगिन के लिए उपयोगकर्ता नाम।
passwordstringलॉगिन के लिए पासवर्ड, सादा पाठ में।

लॉग आउट​

वर्तमान लॉग इन उपयोगकर्ता सत्र को लॉग आउट करता है।

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

ऑपरेशन: GET

उदाहरण​

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

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

कोडविवरण
200सफल ऑपरेशन
defaultसफल ऑपरेशन
प्रतिक्रिया का उदाहरण​

200: सफल ऑपरेशन

{
  "message": "सफलतापूर्वक लॉग आउट हो गया"
}

पैरामीटर​

कोई नहीं

उपयोगकर्ता नाम से उपयोगकर्ता प्राप्त करना​

उपयोगकर्ता को उनके उपयोगकर्ता नाम से प्राप्त करता है।

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

ऑपरेशन: GET

उदाहरण​

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

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

कोडविवरण
200सफल ऑपरेशन
400गलत उपयोगकर्ता नाम प्रदान किया गया
404उपयोगकर्ता नहीं मिला
defaultअप्रत्याशित त्रुटि

200: सफल ऑपरेशन

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

पैरामीटर​

पथ पैरामीटर​
नामप्रकारविवरण
usernamestringप्राप्त करने के लिए उपयोगकर्ता का नाम। परीक्षण के लिए "user" का उपयोग करें।

उपयोगकर्ता को अपडेट करना​

एक उपयोगकर्ता को अपडेट करता है।

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

ऑपरेशन: PUT

उदाहरण​

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

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

कोडविवरण
200सफल ऑपरेशन
400अमान्य उपयोगकर्ता प्रदान किया गया
404उपयोगकर्ता नहीं मिला
defaultअप्रत्याशित त्रुटि

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

पैरामीटर​

पथ पैरामीटर​
नामप्रकारविवरण
usernamestringउस उपयोगकर्ता का उपयोगकर्ता नाम जिसे अपडेट करना है
अनुरोध बॉडी​
नामप्रकारविवरण
bodyUser object(आवश्यक) अपडेट की गई जानकारी के साथ User ऑब्जेक्ट।

किसी यूज़र को हटाना​

किसी यूज़र को हटाता है।

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

ऑपरेशन: DELETE

उदाहरण​

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

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

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

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

पैरामीटर​

पथ पैरामीटर​
नामप्रकारविवरण
usernamestringजिसे हटाया जाना है, उस उपयोगकर्ता का उपयोगकर्ता नाम