# trailblazer/roar

Parse and render REST API documents using representers.

Repository: https://github.com/trailblazer/roar
Canonical: https://ross.abutalabs.com/products/roar
Homepage: http://www.trailblazer.to/gems/roar
Language: Ruby
License: MIT
License Family: permissive
Last push: 2023-01-17T15:54:37+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": 5723, "days_push": 1324, "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 1838, forks 137 (observed 2026-08-28T04:05:42.801772+00:00)

## What it is
Roar is a Ruby framework for parsing and rendering REST API documents using representers, supporting JSON, JSON-HAL, and XML formats. Its bi-directional representers let you both render representations from Ruby objects and parse incoming documents to update them, making it useful for API servers and clients alike.

## Use cases
- render JSON API responses from Ruby models
- parse incoming REST documents into Ruby objects
- build hypermedia APIs with HAL-JSON links
- serialize models to XML for legacy clients
- build API clients that consume hypermedia
- define reusable API document structures with decorators

## When to choose
- you need bi-directional serialization for REST documents in Ruby
- you want hypermedia support like HAL-JSON or JSON API
- you need a framework-agnostic layer that works with Rails, Sinatra, or Hanami

## When to avoid
- you need a full REST framework with routing and controllers
- your project requires actively maintained dependencies with frequent releases
- you only need simple JSON serialization without hypermedia

## Facets
- artifact type: library
- maturity: maintenance
- function: serialization, templating, http-client
- domain: apis, web-development, backend
- platform: ruby
- tags: rest, hypermedia, hal-, -api, representers, bidirectional-parsing, xml, framework-agnostic

## Member repositories
- trailblazer/roar (main) score 23

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:42.801772+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-30T03:18:17.412670+00:00, confidence not recorded.
  - readme: https://github.com/trailblazer/roar (fetched 2026-08-28T04:05:42.801772+00:00, sha 438f0648f5c3)
- Data as of 2026-08-30T08:39:29.467469+00:00.