REST Resources Actions

Sebastien Dubois edited this page Dec 9, 2016 · 1 revision

About

API calls that send a response that's not a resource per se are not uncommon depending on the domain. Actions like the following are your clue that you might not be dealing with a "resource" response:

  • calculate
  • translate
  • convert
  • ...

One example is if you want to convert a currency to another. Other examples include actions such as login and logout.

In those cases, you are not dealing with resources, you are dealing with actions.

Rules

First and foremost, you MUST try to limit the number of actions (see next section for help).

Actions...

  • SHOULD be named using verbs and not nouns
  • SHOULD be isolated from the rest of your API under an "actions" resource

To execute an action, your API clients MUST use POST. Here's an example:

POST .../api/v1/actions/convert
Accept: application/json
{
    "from": "USD",
    "to": "EUR",
    "amount": "25.00"
}
 
HTTP/1.1 200 OK
{
    "result": "22.46",
    "exchangeRate": "0.90"
}

We do NOT recommend this, but you MAY decide to provide an "actions" resource to which API users could POST the actions to execute and require that the payload contains the name of the action to perform. For example:

POST .../api/v1/actions
Accept: application/json
{
    "action": "CONVERT",
    {
        ...
    }
}

Limiting the number of actions

To limit the number of actions in your REST API you could try to:

  • restructure the action to appear like a field of a resource (works if the action doesn't take parameters)
    • for example, an activate action could be mapped to a boolean 'activated' field and updated via a PATCH to the resource
  • treat the action like a sub-resource
    • for example, GitHub's API lets you star a gist with PUT /gists/:id/star and unstar via DELETE /gists/:id/star
  • regroup/isolate actions under a generic pseudo-resource (e.g., utilities) so as to avoid creating an RPC-like API

If you MUST define the action apart from actual resources, then make sure to clearly document that the action is NOT a resource.

History

REST

REST

REST API Design Goals

REST Constraints

REST Resources

REST Resources Design Workflow

REST Resources Naming

REST Resources URIs

REST Resources Parameters

REST Resources Single items and collections

REST Resources Relations

REST Resources Many to many Relations

REST Resources Relations expansion

REST Resources Actions

REST API Versioning

REST API Documentation

HTTP

HTTP Methods

HTTP Status Codes

HTTP Status Codes Success (2xx)

HTTP Status Codes Redirection (3xx)

HTTP Status Codes Client Error (4xx)

HTTP Status Codes Server Error (5xx)

Media types

CRUD Operations

CRUD About

CRUD Create Single item

CRUD Retrieve Single item

CRUD Retrieve Collection

CRUD Update Single item

CRUD Delete Single item

Pagination

Pagination About

Pagination Rules and metadata

Pagination Example

Pagination Out of range/bounds

Filtering

Filtering About

Filtering Using styles

Filtering Using includes

Filtering Using excludes

Sorting

Sorting About

Sorting Metadata

Sorting Example

Searching

Searching About

Searching Local search

Searching Scoped search

Searching Global search

Searching Advanced search

Searching Wildcards

Searching Formatting

Long-running operations

Long-running Operations About

Long-running Operations Flow

Long-running Operations Rules

Long-running Operations Example

Concurrency control

Concurrency About

Concurrency Headers to use

Concurrency vs Delete operation

Concurrency vs Pagination

Caching and conditional requests

Caching and conditional requests About

Caching and conditional requests Rules

Caching and conditional requests HTTP headers

Conditional requests

Cache control

Error handling

Error handling About

Error handling Expectations

Error handling Status codes

Error handling Error details

Error handling Example with a single error

Error handling Example with multiple errors

Error handling Example with parameters

Error handling Example with additional metadata

Error handling Warnings

Compression

Compression About

Bulk operations

Bulk operations About

Bulk operations Types

Bulk operations Atomic

Bulk operations Non-atomic

Bulk operations Asynchronous

Bulk operations HTTP status codes

Bulk operations Resources naming convention

Bulk operations Errors

Bulk operations Creation example

Bulk operations Update example

Bulk operations Create and update example

File upload

File upload About

File upload File sizes

File upload Simple file upload

File upload Simple file upload example

File upload Complex file upload

File upload Complex file upload example

Security recommendations

REST Security General recommendations

REST Security Transport layer

REST Security Error handling

REST Security Insecure direct object references

REST Security CORS

REST Security Updates and consistency

REST Security API keys

Miscellaneous

Data formats

Internationalization

Rate limiting

Null values

Dates and times

Redirections

References

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.