Especificação OpenAPI

Descrição legível por máquina da API REST do CleverUtils. Use-a para gerar SDKs de cliente, popular clientes de API como Postman ou Insomnia, ou navegar pelos endpoints de forma interativa no Swagger UI.

Baixar a especificação

A especificação OpenAPI 3.1 está em:

URL
https://cleverutils.com/api/v1/openapi.json

Você pode baixá-la diretamente com cURL:

cURL
curl -O https://cleverutils.com/api/v1/openapi.json

Gerar um SDK de cliente

Use o openapi-generator para criar um cliente tipado em qualquer linguagem. Exemplos:

Cliente Python
openapi-generator-cli generate \
  -i https://cleverutils.com/api/v1/openapi.json \
  -g python \
  -o ./cleverutils-python-client
Cliente TypeScript
openapi-generator-cli generate \
  -i https://cleverutils.com/api/v1/openapi.json \
  -g typescript-fetch \
  -o ./cleverutils-ts-client
Cliente Go
openapi-generator-cli generate \
  -i https://cleverutils.com/api/v1/openapi.json \
  -g go \
  -o ./cleverutils-go-client

Importar no Postman / Insomnia

Swagger UI interativo

Navegue e teste endpoints diretamente no seu navegador:

O Swagger UI é carregado sob demanda. Clique no botão abaixo para renderizar o explorador de API interativo. Não o carregamos automaticamente para manter esta página leve.

Cobertura da especificação

A especificação OpenAPI descreve:

Versionamento

A especificação é versionada junto com a API. Mudanças incompatíveis irão para um novo /api/v2/openapi.json com pelo menos 6 meses de aviso prévio. Mudanças retrocompatíveis (novos endpoints, novos campos opcionais) entram na v1 imediatamente.

Veja também:

Solicitar um recurso

0 / 2000