> For the complete documentation index, see [llms.txt](https://guias.mosaico.gov.pt/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guias.mosaico.gov.pt/guias-praticos/boas-praticas-para-a-publicacao-de-api-a-consumir-pela-administracao-publica/crie-esquemas-de-mensagens-bem-definidos-e-faceis-de-consumir.md).

# Crie esquemas de mensagens bem definidos e fáceis de consumir

As API 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 API estatísticas. Evite criar códigos de erro personalizados que exijam análise exaustiva pelo consumidor; as respostas e mensagens de erro devem evitar detalhes técnicos dos quais o consumidor da API não tem visibilidade.