Histórico da Página
...
Consideramos uma API o agrupamento de endpoints que façam parte da mesma unidade de negócio, criar um novo grupo de endpoints implica em preocupações como versionamento, disponibilidade e documentação. Usamos como base a estrutura "{protocolo}://{dominio}/{api}/{produto}/{agrupador}/{versao}/{recurso}". Ex: https://fluig.totvs.com/api/fluig/ecm/v1/users. A partir deste ponto deve-se considerar como regra básica a complexidade necessária para descobrir estes endpoints, ou seja, o agrupamento deve facilitar e não complicar a descoberta dos serviços.
Informações |
---|
APIs escritas utilizando o protocolo de mensagem padronizada não devem definir o nome do produto na URL. A ideia de APIs padronizadas é que a mesma assinatura atenda diferentes produtos. A assinatura de API padronizada segue a nomenclatura abaixo: "{protocolo}://{dominio}/{api}/{agrupador}/{versao}/{recurso}" |
Estrutura OAS (Open Api Specification 3.0.1):
...