zipmark/rspec_api_documentation

Health v2 · maintenance only

Adoption not part of the score

1452 stars · 368 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

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

library · maturity active

testing api-documentation documentation testing documentation apis web-development ruby cli rspec rails acceptance-testing openapi api-docs

Member repositories

For agents

markdown · JSON · MCP: product_card(name="zipmark/rspec_api_documentation")