Guia de Estilos das APIs do MagaZord

Motivação

O objetivo desse documento é o de facilitar o trabalho dos envolvidos com a construção e o uso da APIs da MagaZord sendo uma referência de práticas para interoperabilidade da plataforma para com os sistemas da empresa e de terceiros.

Diretrizes

Estas diretrizes estabelecem a base para colaboração, estabilidade e extensibilidade sendo dividas em 5 partes:

• Diretrizes Gerais: Recomendações gerais para o Design de APIs
• Protocolo: Práticas relacionadas a comunicação HTTP
• Mensagens: Definições sobre a estrutura de Mensagens
• Execução: Orientações sobre a sua operacionalização
• Manutenção: Diretrizes para garantir a sua manutenção e evolução saudável

Casos de Uso

Este projeto tem como objetivo fornecer diretrizes para design e desenvolvimento de APIs na Magazord.

Útima Revisão

Julho de 2025