Versionamento da API

Padrões REST e versionamento.

---

Base URL

/api/v1

---

Padrão REST

Método	Endpoint	Ação
GET	/api/v1/contracts	Listar recursos
GET	/api/v1/contracts/:id	Buscar recurso por ID
POST	/api/v1/contracts	Criar recurso
PUT	/api/v1/contracts/:id	Atualizar recurso completo
PATCH	/api/v1/contracts/:id/status	Atualização parcial
DELETE	/api/v1/contracts/:id	Excluir recurso (soft delete)

---

Nomenclatura de Rotas

• Usar plural para recursos: /contracts, /templates
• Usar kebab-case para rotas compostas: /contract-resources
• Sub-recursos após o ID: /contracts/:id/parts

---

Exemplos

GET    /api/v1/contracts              # Listar contratos
GET    /api/v1/contracts/:id          # Buscar contrato
POST   /api/v1/contracts              # Criar contrato
PUT    /api/v1/contracts/:id          # Atualizar contrato
DELETE /api/v1/contracts/:id          # Excluir contrato

GET    /api/v1/contracts/:id/parts    # Listar partes do contrato
POST   /api/v1/contracts/:id/parts    # Adicionar parte
DELETE /api/v1/contracts/:id/parts/:partId  # Remover parte

---

Documento atualizado em Janeiro 2026