173просмотров
19 марта 2024 г.
Score: 190
Сегодня на работе реализовался забавный случай: бэк выкатил обновление, поменялась модель запросов, на фронте к этому были правки неделю назад. В результате все сломалось. Причину нашли на созвоне: один разработчик другому в месенджере на словах неправильно объяснил вложенность структур. (Выключил микро чтобы нормально посмеяться без звука). Дальше лучше: одни не откатывают, потому что “да че вы там одно поле у себя поправьте: все заработает”, у других уже другая таймзона и рабочий день давно кончился, а третьи заканчивают рабочий день на два часа раньше потому что все лежит. Из таких жизненных ситуаций рождаются стандарты и лучшие практики. Недолго гугля можно найти best practices по API:
1. Конечные точки в URL – имя существительное, не глагол
2. Множественное число
3. Документация
4. Версия вашего приложения
5. Пагинация
6. Использование SSL
7. HTTP методы
8. Эффективное использование кодов ответов HTTP
Нас интересуют 3 - Методы описаны и задокументированы в каком-нибудь Swagger (+ тут же из описания можно сгенерировать код моделей и апи клиента, сократив время разработки) и 4 - если вносятся критические изменения (breaking change), можно и версию обновить Понятно, без духоты, убыток минимальный, но все равно хороший анекдот