Кодови одговора на АПИ за одмор и врсте захтева за одмор

rest api response codes

У овом упутству ћемо научити о различитим РЕСТ кодовима одговора, типовима РЕСТ захтева и неким најбољим праксама које треба следити :

У претходном упутству, РЕСТ АПИ Арцхитецтуре Анд Цонстраинтс, научили смо о веб услугама, РЕСТ Арцхитецтуре, ПОСТМАН, итд.

За више информација о томе можемо се обратити првом водичу за РЕСТ АПИ.

Кад год претражите било коју реч или фразу у претраживачу, претраживач шаље захтев веб серверу. Веб сервер враћа троцифрени код одговора који указује на статус захтева.

Шта ћете научити:

• Шифре одговора АПИ-ја за одмор
• Различите врсте ОДМОРНИХ захтева
  • # 1) ГЕТ
  • # 2) ГЛАВА
  • # 3) ПОСТ
  • # 4) СТАВИТЕ
  • # 5) ОПЦИЈЕ
  • # 6) ПАТЦХ
• Најбоље праксе током валидације РЕСТ АПИ-ја
• Закључак
  • Препоручено читање

Шифре одговора АПИ-ја за одмор

Ево неколико примера кодова одговора које ћемо нормално видети током извођења РЕСТ АПИ тестирања преко ПОСТМАН-а или преко било ког РЕСТ АПИ клијента.

# 1) Серија 100
Ово су привремени одговори

• 100 Наставите
• 101 Пребацивање протокола
• 102 Обрада

# 2) Серија 200
Клијент прихвата захтев, који се успешно обрађује на серверу.

скл упит за праксу питања одговори пдф

• 200 - ОК
• 201 - Створено
• 202 - Прихваћен
• 203 - Неауторитативне информације
• 204 - Без садржаја
• 205 - Ресетуј садржај
• 206 - Делимични садржај
• 207 - Више статуса
• 208 - Већ пријављено
• 226 - ИМ се користи

# 3) Серија 300
Већина кодова повезаних са овом серијом су за преусмеравање УРЛ адреса.

• 300 - вишеструки избор
• 301 - Премештено трајно
• 302 - Пронађено
• 303 - Провери остало
• 304 - Није измењено
• 305 - Користите прокси
• 306 - Свитцх Проки
• 307 - Привремено преусмеравање
• 308 - Стално преусмеравање

# 4) 400 серија
То су специфичне за грешке на страни клијента.

• 400 - Лош захтев
• 401 - Неовлашћено
• 402 - Потребно плаћање
• 403 Забрањено
• 404 - Није пронађено
• 405 - Метода није дозвољена
• 406 - Није прихватљиво
• 407 - Потребна је потврда идентитета проксија
• 408 - Време истека захтева
• 409 - Сукоб
• 410 - Отишао
• 411 - Потребна дужина
• 412 - Предуслов није успео
• 413 - Корисни терет је превелик
• 414 - УРИ је предугачак
• 415 - Неподржани тип медија
• 416 - домет није задовољавајући
• 417 - Очекивање није успело
• 418 - Ја сам чајник
• 421 - Погрешно упућен захтев
• 422 - Необрадиви ентитет
• 423 - закључано
• 424 - Неуспешна зависност
• 426 - Потребна надоградња
• 428 - Потребан предуслов
• 429 - Превише захтева
• 431 - Превелика поља заглавља захтева
• 451 - Недоступно из правних разлога

# 5) 500 серија
Они су специфични за грешку на серверу.

• 500 - Интерна грешка сервера
• 501 - Није примењено
• 502 - Бад Гатеваи
• 503 - Услуга није доступна
• 504 - Истекло време преласка
• 505 - ХТТП верзија није подржана
• 506 - Варијанта такође преговара
• 507 - Недовољно складиште
• 508 - Откривена петља
• 510 - Није продужено
• 511 - Потребна је мрежна потврда идентитета

Поред овога, постоји неколико различитих кодова који постоје, али они ће нас одвојити од наше тренутне расправе.

Различите врсте ОДМОРНИХ захтева

Овде ћемо разговарати о свакој методи РЕСТ АПИ-ја заједно са колекцијама.

Белешка: Постоји толико много метода које можемо учинити помоћу ПОСТМАН-а, али разговараћемо само о следећим методама користећи ПОСТМАН.

За демонстрацију ћемо користити лажни УРЛ хттп://јсонплацехолдер.типицоде.цом . Овај УРЛ ће нам дати жељене одговоре, али на серверу неће бити никаквих креирања или модификација.

# 1) ГЕТ

Захтевај параметре:
Метод: ГЕТ
Захтевај УРИ: хттп://јсонплацехолдер.типицоде.цом/постс
Параметар упита: ид = 3;

Одговор примљен:
Шифра статуса одговора: 200 ОК

Тело одговора :

# 2) ГЛАВА

Захтевај параметре:
Метод: ГЛАВА
Захтевај УРИ: хттп://јсонплацехолдер.типицоде.цом/постс

# 3) ПОСТ

# 4) СТАВИТЕ

# 5) ОПЦИЈЕ

Захтевај параметре:
Метод: ОПЦИЈЕ
Захтевај УРИ: хттп://јсонплацехолдер.типицоде.цом/
Заглавља: ​​Цонтент-типе = Апплицатион / ЈСОН

# 6) ПАТЦХ

Најбоље праксе током валидације РЕСТ АПИ-ја

# 1) ЦРУД операције

Састоје се од најмање 4 предвиђене методе и треба да раде у веб АПИ-ју.
ГЕТ, ПОСТ, ПУТ и ДЕЛЕТЕ.

# 2) Руковање грешкама

подразумевани мрежни пролаз није стално доступан

Могући савети за потрошаче АПИ-ја о грешци и зашто је до ње дошло. Такође би требало да пружа детаљне поруке о грешкама.

# 3) Израда верзија АПИ-ја

Помоћу слова „в“ у УРЛ-у означите верзију АПИ-ја. На пример-

хттп://рестапи.цом/апи/в3/пассед/319

Додатни параметар на крају УРЛ-а

хттп://рестапи.цом/апи/усер/инваиидусер?в=6.0

# 4) Филтрирање

Омогућавајући кориснику да наведе, изаберите жељене податке уместо да их пружате одједном.
/ контакт / сам? име, старост, ознака, канцеларија
/ контакти? лимит = 25 & оффсет = 20

# 5) Безбедност

Временска ознака у сваком АПИ захтеву и одговору. Коришћење аццесс_токен да би се осигурало да поверљиве стране позивају АПИ.

оперативни системи отвореног кода за рачунаре

# 6) Аналитика

Ако имате Аналитику у свом РЕСТ АПИ-ју, добићете добар увид у АПИ који се тестира, посебно када је број преузетих записа веома велик.

# 7) Документација

Треба обезбедити одговарајућу документацију како би је потрошачи АПИ могли користити и ефикасно трошити услуге.

# 8) Структура УРЛ-а

Структура УРЛ-а треба да остане једноставна, а корисник треба да може лако да прочита име домена преко њега.

На пример , хттпс://апи.тестдомаин.цом.

Операције које треба извршити преко АПИ-ја за одмор такође би требало да буду врло једноставне за разумевање и извођење.

На пример, за клијента е-поште:

ДОБИТИ: реад / инбок / мессагес - Дохваћа списак свих порука у фолдеру Примљено
ДОБИТИ: реад / инбок / мессагес / 10 - Чита 10^тхпорука у пријемном сандучету
ПОШТА: цреате / инбок / фолдерс - Направите нову фасциклу у фолдеру Примљено
ИЗБРИШИ: Избриши / нежељену пошту / поруке - избришите све поруке из директоријума нежељене поште
СТАВИТИ: фолдерс / инбок / субфолдер - Ажурирајте информације које се односе на потфасциклу под инбок.

Закључак

Многе организације више воле да примењују РЕСТ веб АПИ, јер је врло једноставан за примену, има мање стандарде и правила која треба следити, лак за приступ, лаган и лак за разумевање. ПОСТМАН има своје предности када се користи са РЕСТфул АПИ због свог корисничког корисничког интерфејса, једноставности употребе и тестирања, бржег одзива и нове функције РУННЕР.

У следећем упутству у овој серији Водича за АПИ за одмор аутоматизоваћемо тест случајеве које смо извршили ручно.

Препоручено читање

• Како аутоматизовати захтеве за АПИ помоћу „Будите сигурни“ и Јенкинс
• РЕСТ АПИ тестирање са краставцем применом БДД приступа
• 10 најбољих алата за тестирање АПИ-ја у 2021. години (СОАП и РЕСТ АПИ алати за тестирање)
• РЕСТ АПИ тестирање помоћу Спринг РестТемплате и ТестНГ
• Како створити РЕСТ пројекат у СоапУИ Про: Водич бр. 13
• Рад са ХТТП захтевима у ЈМетер-у
• Врсте ризика у софтверским пројектима
• Разлика у СОАП-у против ОСТАЛОГ: Поређење перформанси и безбедности