# Apipie/apipie-rails

Ruby on Rails API documentation tool

Repository: https://github.com/Apipie/apipie-rails
Canonical: https://ross.abutalabs.com/products/apipie-rails
Language: Ruby
License: Apache-2.0
License Family: permissive
Last push: 2026-06-26T14:25:27+00:00

## Health v2 (maintenance only)
Score: 80/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 89, release rhythm 58, longevity 100
- inputs: {"age_days": 5426, "days_push": 68, "days_rel": 68, "gap_med": 311, "n_releases_24m": 2}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2507, forks 454 (observed 2026-08-28T04:06:57.213390+00:00)

## What it is
Apipie-rails is a DSL and Rails engine for documenting RESTful APIs in Ruby on Rails applications. It lets developers describe API endpoints through Ruby code, serving the generated docs from within the app and exposing them as JSON.

## Use cases
- document a rails rest api
- generate api docs from controller code
- serve interactive api documentation in my app
- validate request params against documented api
- export api documentation as
- keep api docs in sync with routes

## When to choose
- you have a Ruby on Rails app with a RESTful API needing in-app documentation
- you want docs defined in Ruby DSL rather than comments or separate spec files
- you want to reuse documentation data for validation or JSON export

## When to avoid
- your API is not built on Rails
- you prefer OpenAPI-first workflows with spec files generated independently of code
- you need documentation for GraphQL or non-REST APIs

## Facets
- artifact type: library
- maturity: stable
- function: api-framework, api-documentation, documentation
- domain: web-development, backend, apis, documentation
- platform: ruby
- tags: rails, rest-api, dsl, openapi, rubygems, web-server

## Member repositories
- Apipie/apipie-rails (main) score 80

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:57.213390+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-30T02:26:32.889812+00:00, confidence not recorded.
  - readme: https://github.com/Apipie/apipie-rails (fetched 2026-08-28T04:06:57.213390+00:00, sha 8216615cd41e)
- Data as of 2026-08-30T08:39:29.467469+00:00.