resource
Anything an API gives a name to and lets clients work with, such as one task, a collection of tasks or a job.
In more detail
A resource is identified by an address and is never sent itself; what travels is a representation of its current state. Name resources with stable nouns so the address survives changes to how they are stored.
Related terms
- representation — The data sent to describe a resource’s state in one particular format, such as a JSON document for a task.
- URI — A string that identifies a resource, written with a scheme and usually a path, such as https://api.example.com/tasks/1; every URL is a URI.
- collection resource — A resource that holds a set of similar items, addressed with a plural noun such as /tasks.
- sub-resource — A resource addressed beneath another, such as /tasks/1/owner, usually to express a relationship.
Taught in
- What An API Is, And The Alternatives — Modern API Architecture: REST, GraphQL & gRPC
- The REST Constraints — Modern API Architecture: REST, GraphQL & gRPC
- Naming Resources And Collections — Modern API Architecture: REST, GraphQL & gRPC
- Partial Responses — Modern API Architecture: REST, GraphQL & gRPC
- Fifteen Traces For Six Bookings: Where Context Was Lost — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Ninety Minutes, No Question Count: Exam Strategy — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Two Names For One Fact: Semantic Conventions And Resources — OpenTelemetry Certified Associate (OTCA) Exam Prep
- A Warning With An Address: Correlating Signals — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Fundamentals Sprint: One Declined Card — OpenTelemetry Certified Associate (OTCA) Exam Prep
- A Library That Traces Nothing, Safely: API, SDK And Extension — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Fifty Two Spans, Four Requests: The Trace Data Model — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Three Hundred Milliseconds In One Place: Tracing In Code — OpenTelemetry Certified Associate (OTCA) Exam Prep
- A Histogram That Could Not Answer: Views — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Keep Your Logger: The Logs Bridge And Log Records — OpenTelemetry Certified Associate (OTCA) Exam Prep
- The Spans Of A Job That Ended Too Soon: SDK Pipelines — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Nine Lines, Five Bugs: Configuring The SDK — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Six Launches, No Code Changes: Language Agents — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Sixty Two New Names: Collector Components And Pipelines — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Fifty Five In, Fifty Two Out: Transforming Data — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Which Node Was It? Collector Deployment Patterns — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Collector Sprint: Sixteen Predictions — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Failed Twice, Flushed Fine: Error Handling And Schemas — OpenTelemetry Certified Associate (OTCA) Exam Prep
- Maintenance Sprint: Symptoms First — OpenTelemetry Certified Associate (OTCA) Exam Prep
- The Evening Before: Final Review — OpenTelemetry Certified Associate (OTCA) Exam Prep
References
- Roy Fielding: Representational State Transfer (dissertation, chapter 5)
- Google Cloud API design guide: Resource names