Хороший API — это не тот, где всё красиво на слайдах.
Это тот, где уставший разработчик в 2:13 ночи сразу понимает, что сломалось и что делать дальше.
Плохая ошибка выглядит так: `invalid_request`.
Хорошая — как короткая инструкция:
1. что случилось
2. почему это произошло
3. как исправить
4. можно ли повторить запрос
Именно поэтому DX стоит оценивать не только по количеству фич, а по времени до первого успешного вызова. Если онбординг затянулся, проблема почти всегда в продукте, а не в пользователе.
Что важно помнить:
- предсказуемость в API ценнее «умных» сюрпризов
- скучный API — это комплимент
- сообщение об ошибке — часть пользовательского сценария, а не техническая мелочь
Практический вывод простой: перепишите ошибки так, чтобы они помогали действовать, а не гадать. Тогда вы уменьшите нагрузку на поддержку, ускорите интеграцию и сделаете продукт заметно взрослее ⚙️
Product Brief
@ProductBriefPro
Хороший API — это не тот, где всё красиво на слайдах.
Этот пост опубликован в Telegram-канале Product Brief. Подписаться можно по ссылке: @ProductBriefPro.