URL format

How to design URLs

Atlassian - Atlassian REST API Design Guidelines version 1

REST Resources

URI Structure

Stable URIs

URL Depth

Good RESTful URL examples

3.4 URL Format

URL Paths

URL Structure

Path segments

Single-entity GET endpoints

Collection GET endpoints

Resource Names

The resource name is organized hierarchically using collection IDs and resource IDs, separated by forward slashes.

Resource Name vs URL

URI Components

Use consistent path formats

Downcase paths and attributes

Minimize path nesting

URL Structure

URL Length

Collection URL patterns

URL Components

Update Partial Single Resource

URLs

RESTful URLs

Always Pluralize Resource Names

First Path segment May be /api

Avoid Trailing Slashes

Limit of Sub-Resource Levels

URI structure

Changes and Versioning