Manipulate url parameters Restful API

Question

I just need to know how to manipulate url parameters when someone calls my API with parameters.

http://localhost:8100/apis/employee?firstName=john&lastName=Do

I want to use these firstName and lastName parameters on my GET method but I don't know how to extract them.

@GET
@Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
public Response getEmployee() {

//Just need to extract the parameters in here so I can use on the logic to return only the ones that meet the requirements. 

}

Any help would be appreciated. I am using SpringBootApplication on Java

Don't know much about Java, maybe this older answer helps you out — Brainfeeder
– Brainfeeder, Commented Jan 8, 2018 at 15:54

cassiomolin · Accepted Answer · 2018-01-08 16:38:50Z

2

By the annotations shown in your question, you are using JAX-RS (probably with Jersey). So use @QueryParam:

@GET
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Response getEmployee(@QueryParam("firstName") String firstName, 
                            @QueryParam("lastName") String lastName) {
   ...
}

For Spring MVC (that also provides REST capabilities), you want to use @RequestParam:

@RequestMapping(method = RequestMethod.GET,
                produces = { MediaType.APPLICATION_XML_VALUE, 
                             MediaType.APPLICATION_JSON_VALUE })
public Response getEmployee(@RequestParam("firstName") String firstName, 
                            @RequestParam("lastName") String lastName) {
   ...
}

Both JAX-RS (with Jersey) and Spring MVC can be used with Spring Boot. See the documentation for details.

Also refer to this answer for details on the differences between Spring MVC and JAX-RS.

edited Jan 8, 2018 at 16:38

answered Jan 8, 2018 at 16:14

cassiomolin

133k36 gold badges301 silver badges383 bronze badges

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

3 Comments

DoArNa Over a year ago

Yes that is correct, I am using JAX-RS. I have a question. If I want to pull an employee by ID, I can use employeeRepository.findOne() where employeeRepository is an interface extending PagingAndSortingRepository. How about if I want to select an employee based on firstName or lastName what do I do? Do I implement my method on employeeRepository interface?? I am asking just because I don't want to reinvent the wheel :)

cassiomolin Over a year ago

@DoArNa That's out of the scope for your current question, so you should consider asking a new one. However, it would be something like Employee findByFirstNameIgnoreCaseAndLastNameIgnoreCase(String firstName, String lastName).

DoArNa Over a year ago

It seems it is not recognizing the firstName and lastName on "@QueryParam". Do I have to add any annotation "@Path" or something like that? If so, how would that look like?

Nikolai Shevchenko · Accepted Answer · 2018-01-08 15:53:57Z

0

@RequestParam is what you are looking for

public Response getEmployee(@RequestParam("firstName") String firstName, @RequestParam("lastName") String lastName) {
...
}

answered Jan 8, 2018 at 15:53

Nikolai Shevchenko

7,6278 gold badges36 silver badges47 bronze badges

1 Comment

cassiomolin Over a year ago

The OP is using Spring Boot but @GET and @Produces belong to JAX-RS (which can be used with Spring). So the correct annotation is @QueryParam and not @RequestParam. See my answer for further details.

codebrane · Accepted Answer · 2018-01-08 15:54:37Z

0

You can use @RequestParam in your controller method to access the query parameters. e.g.

public Response getEmployee(@RequestParam("firstName") String firstName, @RequestParam("lastName") String lastName)

answered Jan 8, 2018 at 15:54

codebrane

4,6902 gold badges22 silver badges34 bronze badges

1 Comment

cassiomolin Over a year ago

The OP is using Spring Boot but @GET and @Produces belong to JAX-RS (which can be used with Spring). So the correct annotation is @QueryParam and not @RequestParam. See my answer for further details.

Collectives™ on Stack Overflow

Manipulate url parameters Restful API

3 Answers 3

3 Comments

1 Comment

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related