Temalı API'lerin kapsamadığı protokol mekaniği: İş yoklamasıyla 202 Kabul Edildi, 301/302 yönlendirmeleri (ve zincirleme), Yeniden Dene-Sonra 503, garantili 504, 406 ile Kabul tabanlı içerik müzakeresi, HATEOAS bağlantıları, RFC 6902 JSON Yaması ve 410 Kayboldu.
Temel URL: https://funapi.dev/api/protocol/v1 · 12 uç nokta · OpenAPI 3.1 belgesi ve Postman koleksiyonu mevcut. Yeni misiniz? Önce şunu okuyun: başlangıç rehberi.
202 Kabul edildi + anket tamamlandı
POST /protocol/v1/jobs — Asenkron bir iş başlat — 202 Kabul edildi · Yanıt kodları: 202 400 Bu uç noktanın bağlantısıGET /protocol/v1/jobs/{id} — Ankete göre iş bulmak — her ankette ilerleme kaydediliyor. · Yanıt kodları: 200 404 Bu uç noktanın bağlantısı301, 302 ve ardından gelecek bir zincir
GET /protocol/v1/moved/old-dashboard — Kalıcı olarak taşındı — 301 · Yanıt kodları: 301 Bu uç noktanın bağlantısıGET /protocol/v1/moved/new-dashboard — 301'in nereye götürdüğü · Yanıt kodları: 200 Bu uç noktanın bağlantısıGET /protocol/v1/hop — 302 yönlendirme zinciri — onu takip edin · Yanıt kodları: 200 302 400 Bu uç noktanın bağlantısı503 ve 504 talep üzerine
GET /protocol/v1/maintenance — Planlı bakım — 503 + Tekrar Dene · Yanıt kodları: 503 Bu uç noktanın bağlantısıGET /protocol/v1/gateway-timeout — Yukarı akış yavaş — yaklaşık 3 saniye bekliyor, ardından 504 hatası veriyor. · Yanıt kodları: 504 Bu uç noktanın bağlantısıHATEOAS, JSON Patch, 406 ve 410
GET /protocol/v1/export/documents — Accept üzerinden içerik görüşmesi (diğer yöntemlerde 406 hatası) · Yanıt kodları: 200 406 Bu uç noktanın bağlantısıGET /protocol/v1/documents — Belgeleri listele (HATEOAS bağlantıları) · Yanıt kodları: 200 Bu uç noktanın bağlantısıGET /protocol/v1/documents/{id} — Belge alın (silme işleminden sonra 410 hatası) · Yanıt kodları: 200 404 410 Bu uç noktanın bağlantısıPATCH /protocol/v1/documents/{id} — RFC 6902 JSON Yama (işlem/yol/değer) · Yanıt kodları: 200 400 404 409 Bu uç noktanın bağlantısıDELETE /protocol/v1/documents/{id} — Belge silme (yalnızca yöneticiler için, silme işlemi başarısız olursa 410 hatası alınır) (Bearer kimlik doğrulaması gerekir) · Yanıt kodları: 204 401 403 404 410 Bu uç noktanın bağlantısıProtokol Laboratuvarı, kataloğun HTTP semantiği test alanıdır ve çoğu sahte API'nin asla yapmadığı şeyleri kapsar: tamamlanana kadar yokladığınız 202 kabul edilen eşzamansız işler, 301 ve 302 yönlendirmeleri, 503 ve 504 kesintileri, JSON Patch ve Accept başlığınızı karşılayamadığında 406 yanıtı veren içerik müzakeresi. Bir istemci kütüphanesi sizi şaşırtacaksa, sizi burada şaşırtacaktır.
GET https://funapi.dev/api/protocol/v1/moved/old-dashboard — Kalıcı olarak taşındı — 301. Token yok, kayıt yok:
curl -i https://funapi.dev/api/protocol/v1/moved/old-dashboard
Yanıt: 301 Moved Permanently
{
"error": "Moved Permanently",
"message": "The dashboard lives at /moved/new-dashboard now. Note that curl needs -L to follow redirects."
}
Son güncelleme