Google Cloud Platform Blog: API design: Choosing between names and identifiers in URLs

Google Cloud Platform Blog

Product updates, customer stories, and tips and tricks on Google Cloud Platform

API design: Choosing between names and identifiers in URLs

Tuesday, October 17, 2017

By Martin Nally, software developer and API designerhttps://ebank.com/accounts/a49a9762-3790-4b4f-adbf-4577a35b1df7https://library.com/shelves/american-literature/books/moby-dickGoogle Cloud Platform API Design Guide The case for identifiers an often-quoted article
Hierarchical names taxonomy of nature The best of both worlds Google Cloud Platform Identifiers are for look-up. Names are for search.https://ebank.com/accounts/a49a9762-3790-4b4f-adbf-4577a35b1df7" find the book that is [currently] named "moby-dick", and is [currently] on the shelf that is [currently] named "american-literature"https://library.com/search?kind=book&name=moby-dick&shelf=(name=american-literature) Using names and identifiers together https://ebank.com/accountshttps://ebank.com/accounts/a49a9762-3790-4b4f-adbf-4577a35b1df7https://library.com/locations{"kind": "Shelf", "name": "American-Literature", }https://library.com/shelf/20211fcf-0116-4217-9816-be11a4954344https://library.com/inventory{"kind": "Book", "name": "Moby-Dick", "location": "/shelf/20211fcf-0116-4217-9816-be11a4954344" }https://library.com/book/745ba01d-51a1-4615-9571-ee14d15bb4afhttps://library.com/shelf/american-literatature/book/moby-dickhttps://library.com/search?kind=book&name=moby-dick&shelf=(name=american-literature) https://library.com/book/745ba01d-51a1-4615-9571-ee14d15bb4af
The downside of two sets of URLs Permalinks and search URLs: better together Web API Design: The Missing LinkAPI design posts