API - Guia de Estilo

Estrutura de URL

251 views 05/08/2020 06/08/2020 jefersonfrancisco 0

Uma API deve seguir o seguinte formato:

https://{baseUrl}/{domain}/{service}/{type}/{resource}?queryParam1=x&queryParam2=y

Exemplo:
https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/ecossistema/reference_app/entities/tarefa?sort=nome

Sendo que:

  • baseUrl: identifica o ambiente responsável por hospedar a API, sendo “api.senior.com.br” o ambiente de produção;
  • domain: identifica o domínio de negócio que está provendo a funcionalidade. São exemplos de domínios: platform, erp_man, hcm, sam, etc;
  • service: identifica o serviço de negócio que está provendo a funcionalidade. São exemplos de serviços: translationHub, remuneration, moods, contratos, etc;
  • type: identifica o tipo de operação que está sendo provida, sendo valores possíveis: entities, queries, actions, signals;
  • resource: identifica o recurso ou ação de negócio a ser acionada. São exemplos de primitivas: user, consistProposalWageScale, searchBranchesOffice, etc;
  • queryParams: identifica informações extras passadas à funcionalidade de negócio. São exemplos de parâmetros extras: orderBy, offset, size, filter, etc.

Este artigo foi útil para você?