Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What is best way to pass multiple query parameters to a restful api?

Tags:

rest

php

api

I am designing RESTful Api's and would like some advice on designing an API where the caller wants to query records based on more than one search parameter.

I have only seen restful apis that use one parameter.

how should i do this?

e.g. if i have created a restful api for a list of contacts, how would I format a call that returned all contacts with firstname==bob & surname==smith?

I guess it should be a GET because I am retrieving?

My only thoughts are:

http://api.myapi.com/contacts/firstname/bob&surname=smith

But that doesn't seem right ;-(

Please advice.

Also, do any of the php frameworks support this? e.g. symfony, konstrukt etc.

like image 214
DEzra Avatar asked Apr 14 '10 19:04

DEzra


People also ask

How do you pass multiple parameters in query?

Passing Multiple Parameters for QueryString To pass multiple parameters, we will use “&” symbol to separate the other field and value combinations.


1 Answers

I think

http://api.myapi.com/contacts?firstname=bob&surname=smith

is the way to go if you have a set of parameters, all of which are optional.

like image 165
Matti Virkkunen Avatar answered Sep 28 '22 17:09

Matti Virkkunen