URL, әдістер және API қателері

URL, әдістер, қателер конвенциялары ('GET', 'POST', 'PUT', 'DELETE')

Соңғы өңдеу:
Станислав Анисимов
URL, әдістер, қателер конвенциялары ('GET', 'POST', 'PUT', 'DELETE')
Click to expand / collapse

Сенімді және түсінікті API интерфейстерді құрудың нақты ережелерінен басталады. Біз әрбір әзірлеуші не күтетінін білуі үшін ең жақсы REST тәжірибесін ұстанамыз: URL құрылымы логикалық, әдістер әрекетке сәйкес келеді және қателер оңай түсіндіріледі.

Бұл кіру шегін төмендетеді, интеграцияны жеңілдетеді және жүйені хаоссыз кеңейтуге мүмкіндік береді.

URL және HTTP-әдістер конвенциялары

ӘдісМақсатыСұрау үлгісі
`GET`Ресурсты алу`GET /users/42`
`POST`Жаңа ресурс жасау`POST /users`
`PUT`Ресурсты толық жаңарту`PUT /users/42`
`PATCH`Ресурсты ішінара жаңарту (опц.) `PATCH /users/42`
`DELETE`Ресурсты жою`DELETE /users/42`

Есімдер көпше түрінде пайдаланылады ('/users ', '/devices', '/games ')

Ішкі мәндер иерархия ретінде сипатталады ('/users/42/sessions ')

Барлық сұраулар HTTPS арқылы жіберіледі

Қателерді өңдеу стандарттары

КодМәніХабар үлгісі
`400`Дұрыс емес сұрау`Missing required field: email`
`401`Рұқсат етілмеген`Invalid token or expired session`
`403`Кіруге тыйым салынған`Access denied to resource`
`404`Табылмады`User with ID 42 not found`
`409`Қайшылық (мысалы, қайталау)`Email already in use`
`422`Валидация қатесі`Field 'age' must be a number`
`500`Ішкі сервер қатесі`Unexpected exception, contact support`
Қатеге жауап беру құрылымы: 
json
{
"error": {
"code": 400,   "message": "Missing required field: email",   "details": {...}
}
}

Әзірлеушілер үшін артықшылықтар

Артық құжаттамасыз API логикасын тез түсіну

Барлық модульдер мен мәндерге біріздендірілген тәсіл

Стандартты кодтар мен пішімдердің арқасында оңай жөндеу және логикалау

OpenAPI/Swagger, Postman, SDK автогенерациясымен сыйысымдылық

Қолдауды, тестілеуді және CI/CD жеңілдету

Ерекше маңызды жерде

Ашық немесе серіктес API платформалары

Бірнеше пәрмені бар жобалар

Микросервис архитектурасы немесе API-first тәсілі

Мәні мен өзара іс-қимылы көп жүйелер

Бірыңғай конвенциялар API-ны сенімді, түсінікті және ыңғайлы етеді. Біз әр интеграция тез, түсініспеушіліксіз және барынша болжамды болуы үшін ең үздік REST-практикаларды ұстанамыз.

Танымал тақырыптар

Негізгі тақырыптар