How can I use the same endpoint for "multiple" and "single" objects?

Question

I have a .NET Core 5 project (Rest API) that includes a controller (TestController) with an endpoint (AddOrUpdate). The signature of the endpoint looks like this:

[HttpPost, HttpPut]
public virtual IActionResult AddOrUpdate(params TDatabaseModel[] entities).

By itself that one works, but now I always have to specify a list of TDatabaseModel's in the JSON. Now I wanted to create another endpoint, which accepts only one TDatabaseModel, to prevent the creation of a list. The signature looks like this:

[HttpPost, HttpPut]
public virtual IActionResult AddOrUpdate(TDatabaseModel entity)

The problem now is that I get an exception as soon as I specify a single object (not a list) in the JSON body. The exception refers to the fact that the endpoints are "ambigous". I have also tried to make a list of TDatabaseModel's out of the endpoint with "params", but even then it remains ambiguous.

My question: is there a way to pass both a single object and a list of objects WITHOUT using different endpoint routes? So I don't want to end up using different routes (HttpPost:{{URL}}/single && HttpPost:{{URL}}/multiple). Is there any way to do that?

params doesn't make sense there as the serializer will give you an array by default. Have you tried removing that? — Camilo Terevinto
– Camilo Terevinto, Commented Apr 24, 2022 at 13:25
I see your point, but no, is still seen as ambiguous, unfortunately. — CaptTaifun
– CaptTaifun, Commented Apr 24, 2022 at 13:28

Camilo Terevinto · Accepted Answer · 2022-04-24 13:30:32Z

1

No, there is no way, either use always an array or use two endpoints.

Unfortunately, REST does not really have a representation for a batch operation (such as creating/updating multiple entities at once), so which option to go with is entirely opinionated.

answered Apr 24, 2022 at 13:30

Camilo Terevinto

32.2k7 gold badges95 silver badges127 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

CaptTaifun Over a year ago

Yeah, I was afraid of that already. Well, it was worth a try. Thanks for the answer.

Camilo Terevinto Over a year ago

@CaptTaifun Glad to help. I'd suggest you to discuss with consumers of the API before choosing the approach, if this is at all possible. Some people might prefer a separation (explicitness), others might prefer the simplicity of always using the same payload

CaptTaifun Over a year ago

Thanks for the tip. In that case I write the consumer of the API, that's why it is not that bad. Would be nicer if you could have split it up without using different routes, of course, but good. For now I always use a list, let's see how that turns out.

Collectives™ on Stack Overflow

How can I use the same endpoint for "multiple" and "single" objects?

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related