Base URL
Toda requisição combina uma base URL com um caminho sob /public. A especificação OpenAPI declara dois servidores: um de desenvolvimento e
um de produção.
Servidores
| Ambiente | Base URL |
|---|---|
| Produção | https://api.draftin.io |
| Desenvolvimento | http://localhost:3000 |
Estrutura de uma URL
Não há segmento de versão no caminho. Os endpoints públicos ficam todos sob
o prefixo
/public:
https://api.draftin.io/public/posts/slug/meu-primeiro-post
└────────┬───────────┘└──┬──┘└─────────┬──────────────────┘
base URL prefixo recurso + parâmetros Mapa de recursos públicos
Todos os caminhos abaixo são relativos à base URL de produção:
| Recurso | Caminho base |
|---|---|
| Posts | /public/posts |
| Categorias | /public/categories |
| Tags | /public/tags |
| Busca | /public/search |
| Anúncios (Delivery) | /public/ads |
Protocolo
- Sempre HTTPS em produção. Requisições devem usar
https://. - JSON de ponta a ponta: o corpo das respostas é
application/json. Em requisições com corpo (alguns endpoints de anúncios), envieContent-Type: application/json.
const BASE = process.env.DRAFTIN_BASE_URL ?? "https://api.draftin.io";
const url = new URL("/public/posts", BASE);
url.searchParams.set("limit", "10");
await fetch(url, { headers: { "X-API-Key": process.env.DRAFTIN_API_KEY! } });