API - Guia de Estilo

Introdução

1517 views 19/03/2018 28/05/2020 admin 27

Este guia é utilizado para nortear e padronizar o desenvolvimento de APIs expostas na plataforma, permitindo assim melhor governança e facilitar o consumo das APIs pelos desenvolvedores internos e externos.

Este guia aplica-se às:

  • REST APIs: utilizada principalmente nas operações de CRUDL das Entidades;
  • RPC APIs: utilizada principalmente nas operações de Actions e Queries;
  • OData APIs: utilizada principalmente nas operações de CRUDL das Entidades;
  • Developer Experience: padronizar para engajamento e facilidade de uso de API.

Este guia está em constante construção, portanto, toda e qualquer discussão ou contribuição pode ser feita através de nosso fórum.

Este artigo foi útil para você?