I have a collections of customers and each customer has a relationships
resource that looks like this:
{
"customerId" : "string",
"accounts" : [{
"accountId" : "string",
...
}],
"profiles" : [{
"profileId" : "string",
...
}]
}
I am building a REST api to provide access to this resource and sub resources like accounts
and profiles
.
This is the URIs that I came up with:
accounts
sub resourceprofiles
sub resourceBut one issue I see is that relationships
resource looks like a collection. So it will be expected to have a {relationshipId}
after that. But actually it is a single resource. How can I design URIs for this?
If 'relationships' is a single object and not a collection you could go several ways.
It is always good to follow standards. But often you can spend too long worrying about minor issues in which ultimately no matter which way you go, will not make a massive difference.