URL, metodlar, səhvlər konvensiyaları ('GET', 'POST', 'PUT', 'DELETE')
Bu giriş həddini azaldır, inteqrasiyanı asanlaşdırır və sistemi xaos olmadan genişləndirməyə imkan verir.
URL konvensiyaları və HTTP metodları
| Üsul | Təyinat | Sorğu nümunəsi |
|---|---|---|
| 'GET' | Resursun alınması | 'GET/users/42' |
| 'POST' | Yeni resursun yaradılması | 'POST/users' |
| 'PUT' | Resursun tam yenilənməsi | 'PUT/users/42' |
| 'PATCH' | Resursun qismən yenilənməsi (ops.) | `PATCH /users/42` |
| 'DELETE' | Resursun silinməsi | 'DELETE/users/42' |
Çoxluqlu ('/users ', '/devices', '/games ')
Daxili varlıqlar iyerarxiya kimi təsvir olunur ('/users/42/sessions ')
Bütün sorğular HTTPS vasitəsilə gedir
Səhv emalı standartları
| Kod | Dəyəri | Mesaj nümunəsi |
|---|---|---|
| '400' | Səhv sorğu | 'Missing required field: email' |
| '401' | Authorized | 'Invalid token or expired session' |
| '403' | Giriş qadağandır | 'Access denied to resource' |
| '404' | Tapılmadı | 'User with ID 42 not found' |
| '409' | Münaqişə (məsələn, dublyaj) | 'Email already in use' |
| '422' | Validasiya xətası | 'Field' age 'must be a number' |
| '500' | Serverin daxili səhvi | 'Unexpected exception, contact support' |
Səhv cavab strukturu:
- ```json
- {
- “ error “ : {
- “ code “ : 400,
- “ message “ : “ Missing required field: email “ ,
- “ details “ : {...}
- }
- }
- ```
Tərtibatçılar üçün üstünlüklər
Lazımsız sənədləşmə olmadan API məntiqini tez başa düşmək
Bütün modullara və varlıqlara vahid yanaşma
Standart kodlar və formatlar sayəsində asan hata ayıklama və loging
OpenAPI/Swagger, Postman, SDK avtomatik generasiya ilə uyğunluq
Dəstək, test və CI/CD sadələşdirilməsi
Harada xüsusilə vacibdir
Açıq və ya tərəfdaş API platformaları
Çox inkişaf komandaları ilə layihələr
Mikroservis arxitekturası və ya API-ilk yanaşma
Çox sayda mahiyyət və qarşılıqlı əlaqəyə malik sistemlər
Vahid konvensiyalar API-ni etibarlı, başa düşülən və rahat edir. Biz ən yaxşı REST təcrübələrinə riayət edirik ki, hər bir inteqrasiya tez, heç bir anlaşılmazlıq olmadan və maksimum proqnozlaşdırıla bilər.
Bizimlə əlaqə saxlayın
Aşağıdakı formanı doldurun, ən qısa zamanda cavab verəcəyik.