Mevcut bir öğeyi REST API'sindeki bir koleksiyona eklemek için en iyi kalıp hangisidir?

Pragmatik bir REST API tasarlıyorum ve bir koleksiyona mevcut varlıkları nasıl en iyi şekilde ekleyeceğime biraz şaşırdım. Etki alanı modelim, Siteler koleksiyonuna sahip bir Proje içeriyor. Bu katı bir çoktan çoğa ilişkidir ve ilişkiyi açıkça modelleyen bir varlık yaratmaya ihtiyacım yok (yani ProjectSite).

API’m, tüketicilerin bir Projeye varolan bir Site eklemelerine izin verecek. Telefonu kapattığımda, gerçekten ihtiyacım olan tek veri ProjectId ve SiteId. İlk fikrim şuydu:

1. POST myapi/projects/{projectId}/sites/{siteId}

Ama ben de düşündüm

2. POST myapi/projects/{projectId}/sites

JSON içeriği olarak gönderilen bir Site varlığı ile.

Seçenek 1 basit ve işe yarıyor ama pek doğru gelmiyor ve bu modeli izleyemeyen başka ilişkilerim var, böylece API'ma tutarsızlık katar.

Seçenek 2 daha iyi hissediyor ancak iki endişeye yol açıyor:

• Yeni bir Site gönderilirse, bir Site oluşturmalı mıyım veya bir istisna atmalı mıyım (SiteId = 0)?
• İlişkiyi oluşturmak için yalnızca ProjectId ve SiteId'ye ihtiyaç duyduğum için, Site diğer mülkler için yanlış veya eksik verilerle birlikte yayınlanabilir.

Üçüncü seçenek, yalnızca ilişkiyi oluşturmak ve silmek için basit bir uç nokta sağlamaktır. Bu son nokta, yalnızca ProjectId ve SiteId içeren bir JSON yükünü bekler.

Ne düşünüyorsun?

POST "ekleme" fiili ve ayrıca "işleme" fiilidir. PUT, "yarat / güncelle" fiilidir (bilinen tanımlayıcılar için) ve tam hedef URI bilindiği için burada doğru seçim gibi görünüyor. projectIdve siteIdzaten var, yeni bir kimlik oluşturmak için "bir koleksiyona POST" uygulamanıza gerek yok.

PUT ile ilgili sorun, bedenin PUTting yaptığınız kaynağın temsili olmasını gerektirmesidir. Ancak buradaki amaç, Site kaynağını güncellemek yerine "proje / siteler" toplama kaynağına eklemektir.

Birisi mevcut bir Sitenin tam bir JSON temsilcisini koyarsa? Eğer güncelleştirmek Should ve nesneyi güncellemek? Bunu destekleyebilirsin, ama sanki niyet değil gibi geliyor. Dediğin gibi,

Gerçekten ihtiyacım olan tek veri ProjectId ve SiteId.

Aksine, siteIdkoleksiyona POST göndermeyi dener ve POST'un "ekleme" ve "işlem" niteliğine güvenirim:

POST myapi / projeler / {projectId} / sites

{'id': '...'}

Eğer siteler değiştiriyorsanız yana toplama kaynağı değil Sitesi kaynak , istediğin URI var. POST "ekleme / işlemeyi" bilir ve bu kimliğe sahip öğeyi projenin siteler koleksiyonuna ekler.

Bu, hala JSON'u parçalayarak ve kimliği atlayarak proje için yepyeni siteler oluşturmaya kapıyı açık bırakıyor. "Kimlik yok" == "sıfırdan oluştur". Ancak, URI koleksiyonu bir kimlik alır ve başka bir şey almazsa, ne olması gerektiği çok açık.

İlginç soru. :)

Bu gibi şeyler için Patchyöntemi kullanıyoruz . Yapmak istediğiniz, bir Site eklemek için mevcut bir Projeyi değiştirmek.

Yani böyle bir şey işe yarayacak

PATCH myapi/projects/{id} 

İstek gövdesinde Site (ler) i JSON / JSONArray olarak.

Bu şekilde, gerektiğinde Projenin farklı kısımlarını değiştirmek için aynı URL’yi kullanabilirsiniz - uygulamadaki kodunuz kaynağın bu kısmi değişimini gerçekleştirebilecek kadar akıllı olmalıdır.