VOOZH about

URL: https://apistylebook.com/design/topics/collection

⇱ Collection


Collection

What is a collection (set) of resources

Agenzia per l'Italia Digital & Team per la trasformazione digital (Italian administration) - Interoperability model for the Public Administration

Resource collections can use plural names
Code structured data with JSON objects
the payload of a response containing more than one entry returns an object containing a list and not directly a list.

Atlassian - Atlassian REST API Design Guidelines version 1

REST Resources
URI Structure
REST Resources
Collections of Entities

Cisco - API Design Guide

3.6.3 GET

Cloud Foundry - Cloud Controller API v3 Style Guide (Proposal)

Collections

Deliveroo - API Design

Collection GET endpoints

Google - Google API Design Guide

Resources
A collection contains a list of resources of the same type. For example, a user has a collection of contacts.
Methods
The key characteristic of a resource-oriented API is that it emphasizes resources (data model) over the methods performed on the resources (functionality)
Resources examples
Collection ID

Haufe - Haufe API style guide

Collection Resources

Microsoft - Microsoft REST API Guidelines

Collections

PayPal - API Style Guide

Collection Resources
Sub-Resource Collection

Red Hat - Thoughts on RESTful API Design

URLs

Zalando - RESTFul API Guidelines

Resources