Web APIs that Developers Love
summary
Shows concrete API rules: prefer cursor-based paging and RFC5988 web links over brittle page counts; use ID prefixes or slugs and never expose DB keys (sequential IDs ok internally but hide them); prefer embedding small resources or linking to them to keep payloads small; use GraphQL when clients need precise field selection, fragments and introspection; implement backward and forward compatibility by preserving unknown fields and clear version identifiers; return proper HTTP status codes plus structured error objects and documentation links (Twitter-style) for faster debugging.
AI-written summary · about
chapters (24)
- 0:00Introduction
- 3:58Developer Perspective
- 6:27Hypermedia links (HATEOAS)
- 8:07Should You Care about URI Design?
- 8:36Advantages of URI Design
- 10:25Best Practices for URIS
- 11:20Don't Be Dogmatic - Pseudo File Endings
- 12:55Don't Be Dogmatic-Trailing Slashes
- 17:42Best Practices for IDs - Prefixes
- 18:42Best Practices for IDs - Sequential IDs
- 21:09Best Practices for IDs - Slug IDs
- 22:37Partial Responses - Paging
- 23:12Partial Responses - Web Linking (RFC5899)
- 23:54Partial Responses - Streams of Data
- 28:26Siren-Embedding vs. Linking
- 29:31GraphQL-A Data-Fetching API
- 30:40GraphQL Selections
- 31:52GraphQL Mutations
- 33:52GraphQL Introspection API
- 35:08Compatible Extension
- 38:07Backward Compatibility
- 39:59Forward Compatibility
- 43:55Most Common HTTP Error Codes
- 45:59Proprietary Error Codes
