Dinlendirici POST yanıtı için 'En İyi' uygulama

Yani burada yeni bir şey yok, sadece biraz açıklama almaya çalışıyorum ve diğer yazılarda bulamıyorum.

Ben yeni bir kaynak restulfully oluşturuyorum, demek:

/books (POST)

bir vücut ile:

{
  title: 'The Lion, the Witch and the Wardrobe',
  author: 'C. S. Lewis'
}

Yeni kaynağın bir Konum başlığı ile 201 (Oluşturuldu) dönmek gerektiğini biliyorum:

Location: /books/12345

Kendime cevap veremediğim soru, sunucunun vücuda ne dönmesi gerektiğidir.

Sık sık bu tür bir yanıt yaptık:

{
  id: 12345,
  title: 'The Lion, the Witch and the Wardrobe',
  author: 'C. S. Lewis'
}

Bunu birkaç nedenden dolayı yaptım:

1. Angularjs gibi ön uç çerçeveler için API yazdım. Benim özel durumumda açısal kaynakları kullanıyorum ve genellikle kaynağın onu bulması için sadece kimliğe ihtiyacım var. Yanıt gövdesinde kimliği döndürmediysem, Konum başlığından ayrıştırmam gerekirdi.
2. Tüm kitapların GET'inde genellikle sadece kimliği değil, tüm nesneyi döndürürüm. Bu anlamda, müşteri kodumun kimliğin nereden alınacağını ayırt etmesi gerekmez (konum üstbilgisi veya gövde).

Şimdi buradaki gri alanda olduğumu biliyorum, ama çoğu insan kaynağın tamamını geri vermenin 'kötü' bir uygulama olduğunu söylüyor. Peki ya sunucu değişiyorsa / kaynağa bilgi eklerse. Kesinlikle kimliği ekler, ancak zaman damgası gibi başka şeyler de ekleyebilir. Tüm kaynağı geri vermemem durumunda, bir POST yapmak, kimliği döndürmek, daha sonra istemcinin yeni kaynağı almak için bir GET gerçekleştirmesini gerçekten daha iyi mi?

Tüm nesneyi bir güncellemede döndürmek çok alakalı görünmüyor, ancak oluşturulduğunda tüm nesnenin neden geri döndürülmesinin normal kullanım durumunda kötü bir uygulama olduğunu pek anlayamıyorum. Bu, en azından kimliği kolayca almak ve alakalı olduğunda zaman damgalarını almak için yararlı olacaktır. Bu aslında Rails ile iskele alırken var olan varsayılan davranıştır.

İlk POST'unuzla elde edebileceğiniz verileri elde etmek için yalnızca kimliği döndürmenin ve daha sonra bir GET isteği yapmanın hiçbir avantajını görmüyorum.

Her neyse, API'niz tutarlı olduğu sürece, ihtiyaçlarınıza en uygun deseni seçmeniz gerektiğini düşünüyorum. Nasıl bir REST API, imo oluşturmak için doğru bir yolu yoktur.

Yeni nesnenin döndürülmesi, "Tekdüze Arayüz - Kaynakların temsiller yoluyla manipülasyonu" REST prensibine uygundur. Nesnenin tamamı, yaratılan nesnenin yeni durumunun temsilidir.

API tasarımı için gerçekten mükemmel bir referans var, burada: Pragmatik RESTful API Tasarlamak için En İyi Uygulamalar

Burada sorunuzun yanıtını içerir: Güncellemeler ve oluşturma işlemleri bir kaynak temsili döndürmelidir

Diyor ki:

Bir API tüketicisinin güncellenmiş bir gösterim için API'ya tekrar vurmasını önlemek için, API'nın yanıtın bir parçası olarak güncellenmiş (veya oluşturulan) temsili döndürmesini sağlayın.

Bana çok pragmatik geliyor ve yukarıda bahsettiğim REST prensibine uyuyor.