In a REST API client, do you need multiple GET methods for every endpoint?

Question

0.00/5 (No votes)

See more:

I have been trying to learn a bit about api clients.
You have an api at www.expamle.com/api and you need to be able to GET all users at www.expamle.com/api/users and also get them by id at www.example.com/api/users/{id} .

In your code do you need to have a separate function to get ALL records and only one record?
What I don't get is how to properly serialize the results since when you get multiple records it returns you an array but it doesn't work with a single record.

Also, would you need more GET functions for other endpoints such as http://www.example.com/api/products/

What I have tried:

Currently im stuck at serializing an array or a single record on separate functions.

Posted 1-Jan-18 7:54am

Member 13602148

Updated 1-Jan-18 8:29am

Add a Solution

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

F-ES Sitecore · Accepted Answer · 2018-01-01T08:29:00

You just implement the methods you want your clients to use. In terms of different calls for getting one record and getting multiple\all records, they should be different methods so they can have different return types. One will return just the class type, the other an IEnumerable or IList of the class type.