mirror of
https://github.com/Crosstalk-Solutions/project-nomad.git
synced 2026-10-17 13:19:18 +02:00
26 lines
1.3 KiB
Markdown
26 lines
1.3 KiB
Markdown
|
|
# Documentação da API
|
|
|
|
NOMAD disponibiliza um REST API para todas operações. Todos os endpoints estão sob `/api/` e retornam JSON.
|
|
---
|
|
|
|
# Referência Interativa
|
|
|
|
A documentação completa e sempre atualizada dos endpoint é gerada diretamente das rotas e validadores da aplicação e disponibilizada como uma interface interativa do Scalar (https://scalar.com):
|
|
- **[/reference](/reference)** — Navegue por todos os endpoints, esquemas de solicitação/resposta e teste chamadas em tempo real
|
|
- **[/api/openapi.json](/api/openapi.json)** — O documento bruto da OpenAPI 3.1 (importe no Postman, Insomnia, codegen, etc.)
|
|
|
|
Como ela é derivada dos mesmos validadores do VineJS usados pela API, ela nunca fica desalinhada em relação à implementação. Prefira usa-la de qualquer lista de endpoints escrita manualmente.
|
|
---
|
|
|
|
## Convenções
|
|
|
|
**URL base:** `http://<seu-servidor>/api`
|
|
|
|
**Respostas:**
|
|
- Respostas de sucesso incluem { "success": true } e um código de status HTTP 2xx
|
|
- As respostas de erro retornam o código de status HTTP apropriado (400, 404, 409, 500) com uma mensagem de erro
|
|
- Operações de longa duração (downloads, benchmarks, embeddings) retornam 201 ou 202 com o ID de um job/benchmark para consultar o status (polling).
|
|
|
|
Padrão assíncrono: Envie uma tarefa → receba um ID → consulte o endpoint de status até ser concluída.
|