REST API Resource Naming and URL Design/Avoid format suffixes in paths

Negotiate format via headers, not path suffixes.

Section: Naming conventions

Avoid format suffixes in paths

text
text
Prefer: GET /reports/123
Avoid:  GET /reports/123.json
Explanation

Content negotiation and media types are usually cleaner than path-based format suffixes.

Learn the surrounding workflow

Compare similar commands or jump into common fixes when this command is part of a bigger troubleshooting path.

Related commands

Same sheet · prioritizing Naming conventions
Use consistent casing in paths
Pick one URL style and use it consistently.
OpenIn sheettextsame section
Name relationships clearly
Make related collections obvious.
OpenIn sheettextsame section
Keep nesting shallow
Prefer one or two levels of depth.
OpenIn sheettextsame section
Expose canonical resource paths
Each resource should have an obvious direct URL.
OpenIn sheettextsame section
Put resource identity in the path
Use the path for the primary resource being addressed.
OpenIn sheethttp1 tag match
Use query parameters for filtering
Filter a collection with query fields.
OpenIn sheethttp1 tag match