70 lines
1.3 KiB
Text
70 lines
1.3 KiB
Text
---
|
|
type: template
|
|
name: _template-contrato
|
|
description: Template para definição de contratos de API e schemas
|
|
updatedAt: "2026-08-12"
|
|
---
|
|
|
|
# Contrato: <PREENCHER NOME DO SERVIÇO OU DOMÍNIO>
|
|
|
|
## Serviço
|
|
<Nome e breve descrição do serviço ou microsserviço responsável por esta API>
|
|
|
|
## Base URL
|
|
`<URL base de desenvolvimento e/ou produção>`
|
|
|
|
## Autenticação
|
|
<Como autenticar? Token Bearer, API Key, sem auth?>
|
|
|
|
## Endpoints
|
|
|
|
| Método | Rota | Descrição | Auth |
|
|
| :--- | :--- | :--- | :--- |
|
|
| `GET` | `/rota/exemplo` | `<Descrição>` | `Sim/Não` |
|
|
| `POST` | `/rota/exemplo` | `<Descrição>` | `Sim/Não` |
|
|
|
|
---
|
|
|
|
## Detalhamento por Endpoint
|
|
|
|
### `<MÉTODO>` `<ROTA>`
|
|
<Breve descrição adicional do endpoint>
|
|
|
|
**Request Params**
|
|
- `param1` (tipo, obrigatório?): <descrição>
|
|
|
|
**Body Schema**
|
|
```json
|
|
{
|
|
// Exemplo de body esperado
|
|
}
|
|
```
|
|
|
|
**Response Schema (Sucesso)**
|
|
```json
|
|
{
|
|
// Exemplo de resposta 200/201
|
|
}
|
|
```
|
|
|
|
**Códigos de Erro**
|
|
- `400 Bad Request`: <motivo>
|
|
- `404 Not Found`: <motivo>
|
|
|
|
---
|
|
|
|
## Schema Zod de Referência
|
|
<Adicionar fragmento de código Zod caso o projeto utilize validação via schema>
|
|
```typescript
|
|
// z.object({ ... })
|
|
```
|
|
|
|
## Exemplos de Uso
|
|
<Comandos curl, snippets fetch ou scripts de exemplo>
|
|
```bash
|
|
curl -X GET ...
|
|
```
|
|
|
|
## Referências
|
|
<Links para outras documentações, regras de negócio ou ADRs relacionadas>
|
|
- [...]
|