rest - Valid to return different json-response depending on list or retrieve? -
i designing rest api , little stuck on performance matters 2 of use cases in system:
- list campaigns (api/campaigns) - needs return campaign data needed listing , paging campaigns. maybe return 1000 records , take ages retreive , return detailed data. needed data can returned in single db call.
- retrieve campaign item (api/campaigns/id) - need return data campaign , may take second run. multiple db calls needed campaign data single campaign.
my question is: valid return different json-responses 2 calls (if documented) if regards same resource? thinking list response sub set of retreive-response. reason make save db calls , bandwitdh + parsing.
thanks in advance!
i think it's both fine , expected /campaigns , /campaigns/{id} return different information. suggest using query parameters limit amount of information need return. instance, return uri each player unless see ?expand=players query parameter, in case return detailed player information.
Comments
Post a Comment