REST, kaynakları URI ile tanımlayıp HTTP fiilleriyle işlem yapan bir stildir. İyi bir API; tutarlı isimlendirme, öngörülebilir hata modeli ve iyi dokümante edilmiş sözleşmelerle öne çıkar.
Kaynak ve HTTP kullanımı
İsimleri çoğul tutmak, iç içe kaynakları makul derinlikte tutmak ve gereksiz fiil kullanımından kaçınmak bakımı kolaylaştırır. Yanıt kodları (4xx istemci, 5xx sunucu) tutarlı yorumlanmalıdır.
Sürümleme
Yol tabanlı (/v1/), başlık tabanlı veya uyumluluk köprüsü ile kademeli geçiş seçenekleri vardır. Kırıcı değişikliklerde tüketicilere geçiş süresi ve net duyuru planı sunulmalıdır.
Güvenlik
Kimlik doğrulama için OAuth2 ve taşıyıcı token (JWT) yaygındır; token süresi, yenileme ve iptal listesi politikaları tanımlanmalıdır. Oran sınırlama ve giriş doğrulama, kötüye kullanımı azaltır.
OpenAPI ve test
OpenAPI (Swagger) spesifikasyonu hem istemci üretimi hem sözleşme testleri için temel oluşturur. Mock sunucularla ön uç ve entegrasyon ekipleri paralel çalışabilir.
