Requirements & API. Part 1 out of 2.
ฝัง
- เผยแพร่เมื่อ 12 ม.ค. 2025
- Спикер - / ilya-zakharau
На встрече разобрали, что такое Application Programming Interface и почему бизнес-аналитики могут быть вовлечены в их разработку. Ответили на вопрос зачем для API нужны требования, как c ними работать, где тонкая грань между требованиями и дизайном и какие вопросы лучше оставить архитектору.
Спасибо за интересное выступление. К сожалению не присутствовал в онлайне. Есть замечания по примеру API тот что в Excel. 1. Поле status сначала идет в заголовке, а потом появляется в боди. Так быть не должно. 2. Формулировка Path - вводит в заблуждение. Это по сути структура JSON. Большинству понятнее объект. 3. В самом примере JSON появляется массив - про него не сказано ни слова. Откуда он взялся? 4. Mapping - поправить окончание на ImployeE 5. Тут на любителя, но явно напрашивается объект Imployee , который уже будет включать ФИО, дату рождения, и т.п. 6. Ну и тогда уже, наверное, Responce Body привести пример.
Спасибо за обратную связь! Я пересмотрю шаблон ко 2-й части.
1) Да, это косяк, который я обнаружил уже после вебинара.
2) Соглашусь, здесь можно сделать по понятнее.
3) Тоже недоработка с моей стороны. Как минимум нужно было указать .employmentInfo[].
4) Спасибо.
5) На практике, структура, скорее всего, выглядела бы как вы говорите. Это упрощенный пример.
6) Я сознательно указал только "empoyeeId" в response body, чтобы удержать компактность шаблона.