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 82 caminhos e 102 operações da API. Para uma visão legível de todas as funcionalidades e endpoints agrupados por domínio, consulte Funcionalidades e Endpoints.

Viewing the specification

• openapi.json — complete OpenAPI 3.1 specification JSON file
• Swagger Editor — load the openapi.json file in Swagger Editor for interactive visualization

Regenerating the spec

pnpm docs:openapi

O script de geração:

1. Lê workers/src/routes/registry.ts e extrai todas as rotas (102 operações em 82 caminhos)
2. Validates that each route has a registry entry (scripts/openapi-registry.ts)
3. Converts Zod schemas to JSON Schema via zod-to-json-schema
4. Writes docs/reference/api/openapi.json and docs/public/reference/api/openapi.json

If a new route is not documented in the registry, the build fails (pnpm docs:build).

API Information

• Base URL (production): https://api.neemias.app/api/v1
• Base URL (local): http://localhost:8788/api/v1
• Authentication: Bearer token JWT (HS256) obtained via POST /auth/login
• Format: JSON

---

Source: docs/reference/api/openapi.json