Документация API

Быстрый старт#

Минифицировать таблицу стилей и вывести результат:

$ 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}

Замените {css} на {js} или {html}, а {minify} на {beautify} — работает любая комбинация.

Эндпоинты#

Базовый адрес — {base}. Всё ниже — POST, если не сказано иное.

{lang} — это css, js или html.

Как отправить код#

Каждый эндпоинт принимает тело в трёх видах — выбирайте тот, который проще сформировать вашему клиенту.

Форма urlencoded

Поле {input}, {type}. Такой вид тела запроса принят у подобных API минификации, так что готовому скрипту достаточно поменять адрес.

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

JSON

{type} со строкой в поле {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

Сырое тело

Любой другой content type: телом идёт сам код. Удобно для {example}.

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

Размер

2 МБ на запрос. Всё, что больше, возвращается как 413 и даже не читается.

Параметры запроса#

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

Ответ#

Успешный вызов возвращает 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}"
}

Ответы обычным текстом#

Допишите {raw} к любому эндпоинту форматирования — и телом ответа будет только результат, с типом {type}. Заголовки те же. Удобно, когда запрос идёт из шелла:

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

Заголовки ответа#

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

Ошибки#

Любая ошибка — это JSON одного и того же вида:

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

Лимиты запросов#

На IP-адрес, пять скользящих окон, все действуют одновременно. Запрос должен уложиться во все пять.

Когда окно исчерпано, приходит 429 с заголовком Retry-After: в нём секунды до открытия самого узкого окна. Ничего не ставится в очередь.

Счётчики лежат в небольшой базе на диске, так что перезапуск сервиса никому не выдаёт новые сутки.

{endpoint} показывает текущее состояние всех пяти окон, не тратя запрос.

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

Что сохраняется#

Ничего. Код отправляется на наш сервер, живёт в памяти ровно столько, сколько длится запрос, и удаляется. На диск он не пишется и в логах не появляется. В логи попадают только: укороченный хеш IP, язык, действие, число байт и длительность.