OpenAPI Specification

A especificação OpenAPI 3.1 completa da API do Neemias está disponível em formato JSON. Ela é gerada automaticamente a partir do código-fonte (rotas do Worker e schemas Zod) e cobre todos os 25 endpoints e 29 schemas da API.

Consultar a especificação

• openapi.json — arquivo JSON completo da especificação OpenAPI 3.1
• Swagger Editor — carregue o arquivo openapi.json no Swagger Editor para visualização interativa

Regenerar a spec

pnpm docs:openapi

O script de geração:

1. Lê workers/src/router.ts e extrai todas as 25 rotas
2. Valida que cada rota possui entrada no registro (scripts/openapi-registry.ts)
3. Converte schemas Zod para JSON Schema via zod-to-json-schema
4. Escreve docs/reference/api/openapi.json e docs/public/reference/api/openapi.json

Se uma nova rota não estiver documentada no registro, o build falha (pnpm docs:build).

Informações da API

• Base URL (produção): https://api.neemias.app/api/v1
• Base URL (local): http://localhost:8788/api/v1
• Autenticação: Bearer token JWT (HS256) obtido via POST /auth/login
• Formato: JSON

---

Fonte: docs/reference/api/openapi.json