|
|
|
| [Home](home) | [**Escopo**](escopo) | [Processo](processo) | [Design/Mockups](design_mockups) | [Gerência](gerencia) | [Estudos](estudos) | [Arquitetura](arquitetura) | [Contratos](contratos) | [BD](banco_dados) | [Qualidade](qualidade) | [Configuração](configuracao) | [Instalação](instalacao) | [Instruções](instrucoes) | [Utilização](utilizacao) | [Analytics](Analytics) |
|
|
|
|
| :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: | :----------: |
|
|
|
|
|
|
|
|
# Contratos de comunicação entre o Frontend e o Backend
|
|
|
|
|
|
|
|
## Descrição
|
|
|
|
|
|
|
|
Os contratos são os formatos de mensagem em que ambos os lados concordam em receber, tanto para envio quanto para resposta.
|
|
|
|
Envios para o back podem ser de três tipos, não se limitando a usar somente um:
|
|
|
|
1. Parâmetro de URL (**Params**): valores passados na URL em formato de path, exemplo:
|
|
|
|
- http://cp-planta.com/users/xxx
|
|
|
|
|
|
|
|
No exemplo acima, o **1** é um parâmetro de URL
|
|
|
|
|
|
|
|
2. Parâmetro de Consulta (**Query String**): valores passados na URL após uma interrogação e separados por &, exemplo:
|
|
|
|
- http://cp-planta.com/products?offset=0&limit=10
|
|
|
|
|
|
|
|
No exemplo acima os valores **offset** e **limit** são query strings
|
|
|
|
|
|
|
|
3. Dados do Corpo (**Payload**): dados enviados no corpo (body) da requisição
|
|
|
|
|
|
|
|
## Sumário
|
|
|
|
|
|
|
|
- [Autenticação](#autenticação)
|
|
|
|
- [Usuários](#usuários)
|
|
|
|
- [Produtos](#produtos)
|
|
|
|
- [Categorias](#categorias)
|
|
|
|
- [Grupos](#grupos)
|
|
|
|
- [Composição de Produtos](#composição-de-produtos)
|
|
|
|
- [Preços](#preços)
|
|
|
|
- [Fornecedores/ Clientes](#fornecedores-clientes)
|
|
|
|
- [Relatório de Produtos](#relatório-de-produtos)
|
|
|
|
- [Estoque](#estoque)
|
|
|
|
- [Locais de Estoque](#locais-de-estoque)
|
|
|
|
- [Controle de Lote e Validade](#controle-de-lote-e-validade)
|
|
|
|
- [Relatório de Estoque](#relatório-de-estoque)
|
|
|
|
- [Produção](#produção)
|
|
|
|
- [Etapas de Produção](#etapas-de-produção)
|
|
|
|
- [Status da Produção](#status-da-produção)
|
|
|
|
- [Andamento de Produção](#andamento-de-produção)
|
|
|
|
- [Ocorrências](#ocorrências)
|
|
|
|
- [Relatório de Produção](#relatório-de-produção)
|
|
|
|
|
|
|
|
|
|
|
|
> **Observação:** Consulte a seção *Documentação* no menu [Qualidade](qualidade#documentação) para mais detalhes sobre design patterns.
|
|
|
|
|
|
|
|
### Autenticação
|
|
|
|
|
|
|
|
### Usuários
|
|
|
|
|
|
|
|
### Produtos
|
|
|
|
|
|
|
|
### Categorias
|
|
|
|
|
|
|
|
### Grupos
|
|
|
|
|
|
|
|
### Composição de Produtos
|
|
|
|
|
|
|
|
### Preços
|
|
|
|
|
|
|
|
### Fornecedores/ Clientes
|
|
|
|
|
|
|
|
### Relatório de Produtos
|
|
|
|
|
|
|
|
### Estoque
|
|
|
|
|
|
|
|
### Locais de Estoque
|
|
|
|
|
|
|
|
### Controle de Lote e Validade
|
|
|
|
|
|
|
|
### Relatório de Estoque
|
|
|
|
|
|
|
|
### Produção
|
|
|
|
|
|
|
|
### Etapas de Produção
|
|
|
|
|
|
|
|
### Status da Produção
|
|
|
|
|
|
|
|
### Andamento de Produção
|
|
|
|
|
|
|
|
### Ocorrências
|
|
|
|
|
|
|
|
### Relatório de Produção
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
[**Topo**](#contratos-de-comunicação-entre-o-frontend-e-o-backend) |
|
|
\ No newline at end of file |
