Забезпечте чітку та послідовну структуру вашої реакції на помилку: коли виникає помилка, ваша відповідь на помилку API має відповідати встановленій структурі, узгодженій для всіх запитів. Крім того, ваші відповіді API мають бути ідемпотентними, щоб зробити структуру та відповідь більш передбачуваними.
У цьому розділі ви знайдете кілька основних порад щодо вирішення проблем REST API.
- Уважно перегляньте документацію щодо API Digital Samba. …
- Вивчіть заголовки запитів і відповідей. …
- Перевірте URL-адресу кінцевої точки. …
- Перевірте параметри автентифікації та авторизації. …
- Перевірте параметри запиту. …
- Проаналізуйте коди стану.
На відміну від інших мов, Go відходить від традиційного винятку/спроби/catch для обробки помилок. Це заохочує більш чіткий і зрозумілий підхід до обробки помилок. Замість викидання винятків, які будуть перехоплені десь у коді, у Go помилка – це значення, яке повертає функція, у якій вона виникає.
Відповіді API використовують такі умовні позначення:
- Усі поля відповіді наведено в верблюжому регістрі: userName , envelopeId .
- Усі значення, що представляють константи або перерахування, за винятком помилок, наводяться малими літерами: status: 'created' .
- Константи помилок пишуться великими літерами.
- Поля з uri в назві відносяться до основної URL-адреси.
Ось 9 найкращих:
- Перевірте заголовки запиту та відповіді. …
- Перевірте код статусу. …
- Перевірте кінцеву точку. …
- Перевірте параметри автентифікації. …
- Перевірте параметри запиту. …
- Перевірте тіло. …
- Перевірити журналювання. …
- Шукайте обхідні шляхи.