API belgeleri

Hızlı başlangıç#

Bir stil dosyasını küçültün ve sonucu yazdırın:

$ 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} yerine {js} ya da {html}, {minify} yerine {beautify} yazın. Her kombinasyon çalışır.

Uç noktalar#

Temel adres {base}. Aksi belirtilmedikçe aşağıdakilerin hepsi POST'tur.

{lang}, css, js veya html olabilir.

Kodu göndermek#

Her uç nokta üç gövde biçimini kabul eder; istemcinizde hangisi kolaysa onu seçin.

Form kodlamalı

{type} olarak bir {input} alanı. Küçültme API’lerinin alışılmış olarak beklediği biçim budur, yani mevcut bir betikte yalnızca adres değişir.

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

JSON

{input} dizesini içeren {type}.

$ 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

Ham gövde

Başka herhangi bir içerik türü: gövdenin kendisi koddur. {example} için kullanışlı.

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

Boyut

İstek başına 2 MB. Daha büyüğü okunmadan 413 ile geri döner.

Sorgu parametreleri#

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

Yanıt#

Başarılı bir çağrı JSON döndürür:

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

Düz metin yanıtlar#

Herhangi bir biçimlendirme uç noktasının sonuna {raw} ekleyin; gövde yalnızca sonuçtan ibaret olur, {type} olarak. Başlıklar aynıdır. Çağıran taraf bir kabuksa kullanışlıdır:

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

Yanıt başlıkları#

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

Hatalar#

Her hata, bu türden bir API için alışılmış biçimde JSON’dur; yani o biçimi zaten işleyen bir istemci bizimkileri de işler:

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

İstek limitleri#

IP adresi başına beş kayan pencere, hepsi aynı anda uygulanır. Bir isteğin beşine birden sığması gerekir.

Bir pencere tükendiğinde yanıt 429 olur ve Retry-After başlığı en dar pencerenin yeniden açılmasına kaç saniye kaldığını verir. Hiçbir istek kuyruğa alınmaz.

Sayaçlar diskteki küçük bir veritabanında tutulur, bu yüzden servisi yeniden başlatmak kimseye yepyeni bir gün kazandırmaz.

{endpoint}, hiçbirini harcamadan beş pencerenin de güncel durumunu bildirir.

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

Dış küçültme servisi, ziyaretçi başına değil, sitenin tamamı için dakikada 30 isteğe izin verir. Bunu ortak bir kova takip eder: kova boşaldığında CSS ve JS küçültme, beklemek ya da hata vermek yerine yerel motorla yapılır. Yoğunluk altında engine alanının değiştiğini görebilirsiniz; çıktı her iki durumda da geçerli kalır.

İşi hangi motor yapar#

İki yol, tek sözleşme.

Bulut — CSS ve JS küçültme

Dış bir küçültme servisi; hızlı ve temkinlidir: kaldırılabilecek boşlukları kaldırır, kaldırılamayacakları korur, böylece {calc} gibi şeyler olduğu gibi kalır. Bu servis kodu yalnızca aktarır, kendinden hiçbir şey eklemez.

Yerel — geri kalan her şey

HTML küçültme, üç biçimlendiricinin hepsi ve ortak dış kota bittiğinde ya da servis çevrimdışı kalacak şekilde ayarlandığında CSS/JS küçültme. {tools} üzerine kuruludur; boştaki sürecin küçük kalması için bunlar yalnızca bir istek gerektirdiğinde yüklenir.

Bir isteği tek bir yola sabitlemek için {param} kullanın.

Ne saklanıyor#

Hiçbir şey. Kod, istek süresince bellekte tutulur ve sonra atılır. Diske yazılmaz, hiçbir günlükte görünmez. Günlüklerde yer alanlar: IP'nin kısaltılmış bir hash'i, dil, işlem, bayt sayısı, motor ve süre.