Skip to content
ADP
API Design PrincipleBETA

[ADP-303] Clean and Clear URL Path

Guidance

  • SHOULD make shorter URI instead of a URI with big hierarchy
  • SHOULD limit the depth of resource nesting to a maximum of 3 levels
  • SHOULD use plural nouns for resource collections
  • SHOULD use kebab-case for multi-word resource names
  • SHOULD use query parameters for filtering, sorting, and pagination instead of deep nesting

Examples

DO

http
GET /users/{userId}/albums HTTP/1.1

DON'T

http
GET /organizations/{organizationId}/groups/{groupId}/users/{userId}/albums