# kevinswiber/siren

Structured Interface for Representing Entities, super-rad hypermedia

Repository: https://github.com/kevinswiber/siren
Canonical: https://ross.abutalabs.com/products/kevinswiber-siren
License: MIT
License Family: permissive
Last push: 2020-10-19T19:46:45+00:00

## Health v2 (maintenance only)
Score: 23/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 5172, "days_push": 2144, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1344, forks 74 (observed 2026-08-28T04:04:27.220315+00:00)

## What it is
Siren is a hypermedia specification defining a JSON media type (application/vnd.siren+) for representing entities in Web APIs, including properties, embedded entities, actions, and links. This repository hosts the specification document and examples rather than an executable library.

## Use cases
- design a hypermedia-driven REST API
- serve entities with actions and navigation links as a media type
- learn how HATEOAS media types structure entities and state transitions
- model API responses with embedded sub-entities and rels
- define form-like actions for API state transitions

## When to choose
- you want a well-specified hypermedia media type for a JSON API
- your clients need to discover actions and navigate via links rather than out-of-band knowledge
- you need embedded entities with relationships in API payloads

## When to avoid
- you need a parser, serializer, or framework code rather than a specification
- you want a simple plain-JSON API without hypermedia constraints
- you need actively evolving tooling - the spec has seen no recent releases

## Facets
- artifact type: learning-resource
- maturity: maintenance
- function: serialization, api-framework, documentation
- domain: apis, web-development, backend, documentation
- platform: cross-platform
- tags: hypermedia, media-type, specification, rest, hateoas, web-server

## Member repositories
- kevinswiber/siren (main) score 23

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:04:27.220315+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T08:20:23.676259+00:00, confidence not recorded.
  - readme: https://github.com/kevinswiber/siren (fetched 2026-08-28T04:04:27.220315+00:00, sha 6419358a4c36)
- Data as of 2026-08-30T08:39:29.467469+00:00.