URL კონვენციები, მეთოდები, შეცდომები ('GET', 'POST', 'PUT', 'DELETE')
ეს ამცირებს შესვლის ბარიერს, ამარტივებს ინტეგრაციას და საშუალებას გაძლევთ სისტემის მასშტაბები ქაოსის გარეშე.
URL და HTTP კონვენციები
| მეთოდი | დანიშნულება | შეკითხვის მაგალითი |
|---|---|---|
| 'GET' | რესურსის მიღება | 'GET/მომხმარებლები/42' |
| 'POST' | ახალი რესურსის შექმნა | 'POST/მომხმარებლები' |
| 'PUT' | რესურსის სრული განახლება | 'PUT/users/42' |
| 'PATCH' | რესურსის ნაწილობრივი განახლება (opc.) | `PATCH /users/42` |
| 'DELETE' | რესურსის მოცილება | 'DELETE/users/42' |
მრავლობითში გამოიყენება ('/მომხმარებლები ', '/მოწყობილობები', '/თამაშები ')
ჩასმული ელემენტები აღწერილია, როგორც იერარქია ('/users/42/sessions ')
ყველა მოთხოვნა გადის HTTPS
შეცდომის დამუშავების სტანდარტები
| კოდი | მნიშვნელობა | გზავნილის მაგალითი |
|---|---|---|
| '400' | არასწორი მოთხოვნა | 'Missing Required field: email' |
| '401' | Neavatorizonal | 'Invalid token ან expired session' |
| „403“ | წვდომა აკრძალულია | 'წვდომა წვდომისთვის' |
| '404' | არ არის ნაპოვნი | 'მომხმარებელი არ არის.. |
| '409' | კონფლიქტი (მაგალითად, დუბლირება) | 'Email already in use' |
| '422' | მისაბმელის შეცდომა | 'ველი' არ უნდა იყოს number ' |
| '500' | სერვერის შიდა შეცდომა | 'Unexpected exeption, contact support' |
შეცდომაზე პასუხის სტრუქტურა:
- ```json
- {
- “ error “ : {
- “ code “ : 400,
- “ message “ : “ Missing required field: email “ ,
- “ details “ : {...}
- }
- }
- ```
უპირატესობები დეველოპერებისთვის
API ლოგიკის სწრაფი გაგება ზედმეტი დოკუმენტაციის გარეშე
ერთიანი მიდგომა ყველა მოდულისა და არსის მიმართ
მარტივი გამართვა და ლოგიზაცია სტანდარტული კოდებისა და ფორმატების გამო
თავსებადობა OpenAPI/Swagger- თან, Postman- თან, SDK- ის ავტომატიზაციასთან
მხარდაჭერის გამარტივება, ტესტირება და CI/CD
სადაც განსაკუთრებით მნიშვნელოვანია
პლატფორმები ღია ან პარტნიორი API
პროექტები რამდენიმე განვითარების გუნდთან
მიკრო სერვისების არქიტექტურა ან API-first მიდგომა
დიდი რაოდენობით ერთეულებისა და ურთიერთქმედების მქონე სისტემები
ერთი კონვენცია API- ს საიმედო, გასაგებ და მოსახერხებელ გახდის. ჩვენ ვიცავთ საუკეთესო REST პრაქტიკას ისე, რომ თითოეული ინტეგრაცია სწრაფად მოხდეს, გაუგებრობის გარეშე და მაქსიმალური პროგნოზირებადი.
დაგვიკავშირდით
შეავსეთ ქვემოთ მოცემული ფორმა და ჩვენ გიპასუხებთ უახლოეს დროში.