Documentación de la API

Inicio rápido#

Minifica una hoja de estilos e imprime el resultado:

$ curl --data-urlencode 'input=.card { padding: 8px; margin: 0 auto; }' \
  https://formatter.nextwell.top/api/v1/minify/css/raw
# .card{padding:8px;margin:0 auto}

Cambia {css} por {js} o {html}, y {minify} por {beautify}. Todas las combinaciones funcionan.

Endpoints#

La dirección base es {base}. Todo lo que sigue es un POST salvo que se indique lo contrario.

{lang} es css, js o html.

Cómo enviar el código#

Cada endpoint acepta tres formatos de cuerpo: usa el que te resulte más cómodo con tu cliente.

Codificado como formulario

Un campo {input}, {type}. Es el formato que las API de minificación aceptan por convención, así que un script existente solo cambia de dirección.

$ curl --data-urlencode 'input=body{margin:0;padding:0}' \
  https://formatter.nextwell.top/api/v1/beautify/css

JSON

{type} con una cadena {input}.

$ curl -H 'Content-Type: application/json' \
  -d '{"input":"const a=1;const b=a+1;console.log(b)"}' \
  https://formatter.nextwell.top/api/v1/beautify/js

Cuerpo en crudo

Cualquier otro tipo de contenido: el cuerpo es el código. Cómodo para {example}.

$ curl --data-binary @style.css \
  -H 'Content-Type: text/css' \
  https://formatter.nextwell.top/api/v1/minify/css

Tamaño

2 MB por petición. Cualquier cosa mayor vuelve como 413 sin llegar a leerse.

Parámetros de consulta#

$ curl --data-urlencode 'input=.a{color:red}' \
  'https://formatter.nextwell.top/api/v1/beautify/css?indent=tab'

La respuesta#

Una llamada correcta devuelve JSON:

{
  "ok": true,
  "action": "minify",
  "language": "css",
  "input_bytes": 1024,
  "output_bytes": 640,
  "saved_bytes": 384,
  "saved_percent": 37.5,
  "duration_ms": 42,
  "output": "p{color:red}"
}

Respuestas en texto plano#

Añade {raw} a cualquier endpoint de formato y el cuerpo será el resultado y nada más, como {type}. Las cabeceras son las mismas. Útil cuando quien llama es un shell:

$ curl -s --data-binary @app.js \
  -H 'Content-Type: text/javascript' \
  https://formatter.nextwell.top/api/v1/minify/js/raw > app.min.js

Cabeceras de respuesta#

$ curl -s -D - -o /dev/null --data-urlencode 'input=.a{color:red}' \
  https://formatter.nextwell.top/api/v1/minify/css

Errores#

Todos los errores son JSON con el mismo formato:

{
  "errors": [
    { "status": 429, "title": "Too many requests", "detail": "…" }
  ]
}

Límites de peticiones#

Por dirección IP, cinco ventanas deslizantes, todas aplicadas a la vez. Una petición tiene que caber en las cinco.

Cuando una ventana se agota, la respuesta es 429 con una cabecera Retry-After que indica los segundos hasta que se reabra la más estricta. No se encola nada.

Los contadores viven en una pequeña base de datos en disco, así que reiniciar el servicio no le regala a nadie un día nuevo.

{endpoint} informa del estado actual de las cinco ventanas sin gastar ninguna.

$ curl https://formatter.nextwell.top/api/v1/limits

Qué se guarda#

Nada. El código se envía a nuestro servidor, se mantiene en memoria mientras dura la petición y se descarta. No se escribe en disco y nunca aparece en un registro. Lo que sí guardan los registros: un hash truncado de la IP, el lenguaje, la acción, el número de bytes y la duración.