API uç noktası (endpoint)

Uç nokta, sunucunun yanıt verdiği HTTP metodu ve URL yolu ikilisidir: GET /orders ile POST /orders aynı kaynak üzerindeki iki ayrı uç noktadır. Dokümantasyon, erişim kuralları, hız sınırları ve testler genellikle uç nokta bazında düzenlenir; bir API’nin büyüklüğü de çoğunlukla bu birimle sayılır.

Nasıl çalışır

Yol kaynağı adlandırır, yol parametreleri tek bir örneği seçer (/orders/{id}), sorgu dizesi sonucu daraltır ya da biçimlendirir, metot ise onunla ne yapılacağını söyler. Sunucu her isteği o metot ve yol kalıbı için kayıtlı işleyiciye yönlendirir; yolu eşleşip metodu eşleşmeyen bir istek 404 ile değil 405 ile yanıtlanır.

Yaygın yanılgı

Uç noktanın bir URL olduğu sanılır. Aynı URL farklı bir metotla, farklı kuralları olan farklı bir uç noktadır: GET /orders/7 herkese açıkken DELETE /orders/7 yönetici token’ı isteyebilir. Tek bir metodu test edip diğerlerinin de aynı davrandığını varsaymak, yetkilendirme açıklarının incelemeden sağ çıkmasının yoludur.

Burada deneyin

Her dokümantasyon sayfası uç noktalarını metot, yol ve dönebilecekleri durum kodlarıyla listeler; Pizza API’sindeki DELETE /menu, GET için var olan ama her DELETE isteğine 405 dönen bir yoldur.

İlgili

Diğer terimler

Read this page in English

Tüm sözlük maddeleri · Test teknikleri · 39 mock REST API’nin tamamı

Last updated