Forum Discussion

Olumide's avatar
Olumide
New Contributor
4 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
  • RonRatovsky's avatar
    RonRatovsky
    4 years ago

    At the moment, the OpenAPI does not allow separating responses based on query parameters.

     

    There should be an open issue for it at https://github.com/OAI/OpenAPI-Specification/, though I can't find it at the moment.

Olumide's avatar
Olumide
New Contributor
4 years ago

Thanks for your reply.

 

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

 

  • RonRatovsky's avatar
    RonRatovsky
    Moderator
    4 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.