Briefle words · Code & architecture
Resource
A noun the API manages, such as an order or a customer, addressed by its own URL.
Say it to an AI
Express router for the orders API using RESTful resource naming: plural nouns only, the id as a path parameter (/orders/:id), and the HTTP method as the verb: GET list/show, POST create, PATCH update, DELETE cancel. Nested line items at /orders/:id/items. No action words in URLs.
How an expert would brief the stronger version of “Order routes”.
See it
Try it as a puzzle →The Express router that defines every URL of an online shop's orders API.
Why: In A, order 42 is always /orders/42 and its line items are /orders/42/items; in B the same order is /getOrder?id=42 or /getOrderItems?orderId=42.
Related words
Room 5 · APIs & data
Learn “Resource” in a five-minute lesson