C#•3y ago

Design REST API to request certain fields

Hello, this is a generic question

If a model has six fields, but as a response you only want to include four, a DTO would be used. This means that the

GET /users

GET /users

request would contain a list of users, each with four fields.

Instead of

GET /users

GET /users

, should the request URL be

GET /users?fields=name,username,etc

GET /users?fields=name,username,etc

in this scenario?

I am wondering if this is used in real-life scenarios when the consumer of the API is a SPA.

Jimmacle•12/1/23, 5:53 AM

i would do that if i wanted to support the client choosing exactly which fields they want returned

CoreOP•12/1/23, 6:01 AM

I am displaying the data in a table, which means the user cannot individually choose the rendered fields. So this type of request design should only be used when the user has choice over the displayed data?

Jimmacle•12/1/23, 7:18 AM

right, query parameters are generally for options provided by the client

CoreOP•12/1/23, 7:51 AM

Thank you!