Skip to content
uencoder

SIREN

SIREN is a hypermedia format that expresses executable actions and sub-resources in JSON with actions, links, and entities, supporting forms and fields.

Purpose

To give REST APIs a hypermedia representation with executable (non-GET) operations so clients can discover POST/PUT/DELETE actions.

Mechanism

An entity contains actions (an array of operations, each with name, method, href, fields, type), links (navigation links), and entities (sub-resources). Clients discover and execute operations by action name.

Use cases

  • REST hypermedia action discovery
  • Dynamic form generation
  • API workflows

Related tools

References