Rotas de API

Padrão de Endpoints

Para melhor organização e apresentação do projeto, deve-se seguir a seguinte padronização dos endpoints.

Padrões Gerais

• As rotas devem ser no singular e sem prefixo. ex.: /{entidade}
• Será usado SOMENTE @PathVariable para parametrizações na URL, ex.: /tutor/{id}
• Os nomes dos métodos deveram ser iguais na Controller e sua respectiva Service.

Endpoints GET

• Procurar por ID
  • Método: getById
  • Rota: /id/{id}
• Procurar todos
  • Método: getAll
  • Rota: /all
• Procurar por outro paramêtro
  • Método: getBy{parametro}
  • Rota: '/{parametro}/{valor_parametro}'

Endpoints POST

• Cadastrar
  • Método: create
  • Rota: /post

Endpoints PUT

• Editar
  • Método: update
  • Rota: /update/{id}

Endpoints DELETE

• Desativar
  • Método: delete
  • Rota: /delete/{id}