Forum Discussion

Olumide's avatar
Olumide
New Contributor
5 years ago
Solved

Spec'ing an endpoint that returns different responses depending on params sent

I am new to openapi and am evaluating it in order to spec a REST API characterized by endpoints that return different(ly structured) responses depending on which query parameters are sent to the serv...
OpenApi
Olumide's avatar
Olumide
New Contributor
5 years ago

Thanks for your reply.

 

Do you think such an endpoint design breaks any principles of good REST APIs?

 

RonRatovsky's avatar
RonRatovsky
Icon for Staff rankStaff
5 years ago

I do not. Just because something is not supported by the spec, it doesn't mean it's a bad practice. Whether it makes sense in your situation really depends on the use case.