|
|
# Coopera RS - Documentação da API Backend
|
|
|
| [Home](home) | [Escopo e Cronograma](escopo%20e%20cronograma) | [Processo](processo) | [Design/Mockups](design/mockups) | [Configuração](configuracao) | [Arquitetura](arquitetura) | [Infra](infraestrutura) | [Código](codigo) | [BD](banco%20de%20dados) | [Frontend](Frontend) | [API Backend](API-Backend) |
|
|
|
|--------------|-------------------------|----------------|------------------------|---------------------|--------------------|-------------------|--------------|------------------|----------------|------------------|
|
|
|
|
|
|
---
|
|
|
|
|
|
<div align="center">
|
|
|
<img src="uploads/df63c1ae8acde46d4d1f45f6ab1cd9a5/LogoCooperaRS.png" width="150">
|
... | ... | @@ -6,6 +9,8 @@ |
|
|
|
|
|
---
|
|
|
|
|
|
# Coopera RS - Documentação da API Backend
|
|
|
|
|
|
## Visão Geral
|
|
|
|
|
|
Esta documentação descreve os principais endpoints da API do **Coopera RS**, uma plataforma voltada para o fortalecimento de pequenos empreendedores do Rio Grande do Sul.
|
... | ... | @@ -38,12 +43,6 @@ Os endpoints são expostos por meio de controladores REST no módulo `infrastruc |
|
|
|
|
|
---
|
|
|
|
|
|
## Sumário
|
|
|
|
|
|
| [Home](home) | [Escopo e Cronograma](escopo%20e%20cronograma) | [Processo](processo) | [Design/Mockups](design/mockups) | [Configuração](configuracao) | [Arquitetura](arquitetura) | [Infra](infraestrutura) | [Código](codigo) | [BD](banco%20de%20dados) | [Frontend](Frontend) | [API Backend](API-Backend) |
|
|
|
|--------------|-------------------------|----------------|------------------------|---------------------|--------------------|-------------------|--------------|------------------|----------------|------------------|
|
|
|
|
|
|
---
|
|
|
|
|
|
## Exemplos de Payloads JSON por Endpoint
|
|
|
|
... | ... | @@ -186,21 +185,6 @@ Adiciona um item: |
|
|
#### `DELETE /api/cart/remove/{productId}`
|
|
|
Remove um item.
|
|
|
|
|
|
---
|
|
|
|
|
|
## Serviços Internos
|
|
|
|
|
|
- **EmailService**: Envio de e-mails (cadastro, redefinição).
|
|
|
- **AddressService**: Busca e atualização de endereços por CEP.
|
|
|
- **UserService**: Atualização de perfil, status de verificação e ativação.
|
|
|
- **CategoryService**: (em expansão) Criação e vinculação de categorias.
|
|
|
- **SponsorService**: (planejado) Destaque de produtos/lojas.
|
|
|
|
|
|
---
|
|
|
|
|
|
*Esta documentação é baseada em mocks e estrutura real do frontend e deve ser validada com o Swagger da aplicação para fins de integração.*
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
## Patrocínios (SponsorService)
|
... | ... | @@ -230,3 +214,14 @@ Adiciona destaque a uma loja. |
|
|
"priority": 2
|
|
|
}
|
|
|
```
|
|
|
|
|
|
## Serviços Internos
|
|
|
|
|
|
- **EmailService**: Envio de e-mails (cadastro, redefinição).
|
|
|
- **AddressService**: Busca e atualização de endereços por CEP.
|
|
|
- **UserService**: Atualização de perfil, status de verificação e ativação.
|
|
|
- **CategoryService**: (em expansão) Criação e vinculação de categorias.
|
|
|
- **SponsorService**: (planejado) Destaque de produtos/lojas.
|
|
|
|
|
|
---
|
|
|
|