Crie esquemas de mensagens bem definidos e fáceis de consumir
As APIs devem responder com esquemas de mensagens fáceis de entender e consumir. Evite estruturas de dados brutos, estas devem ser limitadas apenas a dados abertos, relatórios e APIs estatísticas. Evite criar códigos de erro personalizados que exijam análise exaustiva pelo consumidor, as respostas e mensagens de erro, devem abstrair-se de detalhes técnicos dos quais o consumidor da API não tem visibilidade.
Last updated