Apipie/apipie-rails

Health v2 · maintenance only

Adoption not part of the score

2507 stars · 454 forks observed · 2026-08-28

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

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

library · maturity stable

api-framework api-documentation documentation web-development backend apis documentation ruby rails rest-api dsl openapi rubygems web-server

Member repositories

For agents

markdown · JSON · MCP: product_card(name="Apipie/apipie-rails")