Resource
An API resource is a conceptual entity or target exposed through an interface and addressable for access or manipulation.
The Design of Web APIs, Second Edition
A product resource is an API-represented product entity that can be addressed or manipulated by operations.
- How it is used
- Uses business concepts to observe API operations before representing them with HTTP paths, methods, statuses, and data models.
- How deep it goes
- Defines independence, properties, operation targeting, relations, and CRUD patterns, then defers detailed paths and schemas to later design steps.
- Examples
- Uses products, catalogs, prices, blog pages, course offerings, flights, and checkout orders to illustrate resources and relations.
- What you can do after
- Apply it to identify resources and relations, distinguish resources from properties, and map typical operations to HTTP representations.
Read how The Design of Web APIs, Second Edition explains resource →
API Design Patterns
An API resource is a named conceptual entity that the API stores, exposes, or allows clients to manipulate.
- How it is used
- Standardizes API design around a limited set of named things and recurring actions.
- How deep it goes
- Defines resources, maps them to standard lifecycle methods, and explains scope decisions without detailing implementation internals.
- Examples
- Uses flight reservations, image annotations, bounding boxes, notes, messages, books, authors, and change-log entries.
- What you can do after
- Designs resource-oriented APIs with consistent operations, appropriate scope, and clear collection-versus-resource targets.
Kubernetes in Action, Second Edition
An API resource is an addressable Kubernetes API endpoint and representation associated with an object type.
- How it is used
- Structures Kubernetes cluster interaction around addressable representations manipulated through REST operations.
- How deep it goes
- Explains URIs, collections, instances, CRUD methods, and object relationships, then connects resources to manifests, status, and controllers.
- Examples
- Uses deployment collection and instance URIs, YAML or JSON manifests, GET and PUT requests, and API events.
- What you can do after
- Operate/configure Kubernetes objects by addressing resources, posting manifests, retrieving status, and interpreting events.
Read how Kubernetes in Action, Second Edition explains resource →
Related concepts
- jobincludes · A Kubernetes Job is a workload resource that runs Pods for a finite task and tracks execution until the required successful completions are reached.
- attributehas part · An attribute is a named property, value, or piece of information associated with an entity, object, or program element.
- objectkind of · A computational object is a runtime entity or structured value representing data, state, or a resource, with properties or operations defined by its programming model.
- polymorphic resourceincludes · A polymorphic resource is an API resource whose generic interface can represent multiple specific resource implementations with implementation-dependent behavior.
- RESTused by · REST is an architectural style for distributed hypermedia systems that organizes interactions around resources and representations through constraints including a uniform interface, stateless communication, cacheability, and layered components.
- operationused by · An operation is an action or computation performed by or through a system, object, or interface, often producing a result or effect.
These guides are generated from the text of Manning books by Manning's knowledge graph and link to the sections they draw on. The full books are available on liveBook and at manning.com.