単一の製品または製品のコレクションを返す API を開発しているため、http ://api.company.com/products/やhttp://api.company.com/products/1/などのエンドポイントがあります。次の構造でデータを返します。
// http://api.company.com/products/1/
{
Id: 1
Name: "Product 1"
}
// http://api.company.com/products/
[
{
Id: 1,
Name: "Product 1"
},
{
Id: 2,
Name: "Product 2"
}
]
現在、Accept ヘッダーで次のメディア タイプをそれぞれ使用しています。
application/vnd.company.product-v1.0+json // single product
application/vnd.company.products-v1.0+json // collection of products
"product"
と を使用して 2 つのメディア タイプを使用することは理想的ではないように思われます"products"
が、混乱を招くことがわかりますが、それらは異なるデータ構造を返します。だから、両方に1つのメディアタイプのみを使用するかどうかを決定するAPI標準がここにあるかどうか疑問に思っていますか?