2

I'm designing a REST API that supports HTTP GET parameters. In most cases I only accept one value for a parameter. But how should I handle duplicate parameters?

For example, Stack Overflow accepts a GET param tab:

http://stackoverflow.com/?tab=hot
http://stackoverflow.com/?tab=featured

Duplicate parameters are allowed, passing both values is correct:

http://stackoverflow.com/?tab=hot&tab=featured

What should I do? Just go with the first value, thus silently ignoring other values (what SO does) or return an error stating only one value is allowed? In the latter case, what error should I return with what status code (409 Conflict, perhaps)?

Rob
  • 2,466
  • 3
  • 22
  • 40
siebz0r
  • 18,867
  • 14
  • 64
  • 107

2 Answers2

2

I agree with VKSingla that this is a design decision, therefore there is no correct answer only opinions in this matter.

If you ask me I would make a 'strict' API and just throw an error (I would make sure that it is a clear error and not just a random code which doesn't help the user). I prefer this strict approach because if usercode is adding the same param twice it will likely be a bug somewhere in the users code. Revealing this bug as early as possible helps the user finding the bug asap.

If you choose to go with ignoring the other parameters then make sure that the user knows this behavior. For example document 'all duplicate parameters after the first will be ignored'. Undocumented 'magic behavior' like this can make code pretty damn hard to debug.

Rob
  • 2,466
  • 3
  • 22
  • 40
1

This is a design decision. Its your API design on how you want it to function.
If you choose to ignore any one , then the question is which one ?
So, it is simply a conflict. or else
your API can respond with combined data, but the request for that should be like this

https://stackoverflow.com/?tab=hot,featured

Also refer this question Extra Query parameters in the REST API Url

Community
  • 1
  • 1
Vineet Singla
  • 1,609
  • 2
  • 20
  • 34
  • 1
    I agree with you that this is a design decision, but where do you get the idea that `?tab=hot&tab=features` is incorrect and should be `?tab=hot,featured`? It's perfectly legitimate to pass parameters multiple times. – siebz0r May 15 '13 at 12:51
  • When two values corresponds to same parameter, it is always suggested to define them together. This I suppose is best design. – Vineet Singla May 16 '13 at 05:43