# zipmark/rspec_api_documentation

Automatically generate API documentation from RSpec

Repository: https://github.com/zipmark/rspec_api_documentation
Canonical: https://ross.abutalabs.com/products/rspec_api_documentation
Language: Ruby
License: MIT
License Family: permissive
Topics: rspec, api, ruby
Last push: 2025-07-24T16:39:18+00:00

## Health v2 (maintenance only)
Score: 38/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 33, release rhythm 8, longevity 100
- inputs: {"age_days": 5405, "days_push": 405, "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 1452, forks 368 (observed 2026-08-28T04:04:46.489598+00:00)

## What it is
A Ruby gem that generates API documentation automatically from RSpec acceptance specs, primarily for Rails APIs. It produces HTML or JSON output (including OpenAPI format) that can be rendered with viewers like Raddocs or Apitome.

## Use cases
- generate api documentation from rspec tests
- document a rails api automatically
- keep api docs in sync with acceptance tests
- produce openapi specs from rspec specs
- generate html api docs for a ruby api

## When to choose
- you have a Rails or Ruby API tested with RSpec and want docs generated from those tests
- you want documentation that always reflects the current behavior of your API
- you want OpenAPI or JSON output to feed into custom doc viewers

## When to avoid
- your API is not written in Ruby or not tested with RSpec
- you want hand-authored, prose-heavy API documentation rather than test-derived docs
- you use minitest or another test framework

## Facets
- artifact type: library
- maturity: active
- function: testing, api-documentation, documentation
- domain: testing, documentation, apis, web-development
- platform: ruby, cli
- tags: rspec, rails, acceptance-testing, openapi, api-docs

## Member repositories
- zipmark/rspec_api_documentation (main) score 38

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:04:46.489598+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-30T04:35:49.878964+00:00, confidence not recorded.
  - readme: https://github.com/zipmark/rspec_api_documentation (fetched 2026-08-28T04:04:46.489598+00:00, sha 943823e22179)
- Data as of 2026-08-30T08:39:29.467469+00:00.