# Redocly/redoc

📘  OpenAPI/Swagger-generated API Reference Documentation

Repository: https://github.com/Redocly/redoc
Canonical: https://ross.abutalabs.com/products/redoc
Homepage: https://redocly.github.io/redoc/
Language: TypeScript
License: MIT
License Family: permissive
Topics: openapi, swagger, api-documentation, documentation-tool, documentation-generator, redoc, reactjs, openapi3, hacktoberfest, openapi-specification, openapi31
Last push: 2026-08-20T14:24:51+00:00

## Health v2 (maintenance only)
Score: 86/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 98, release rhythm 62, longevity 100
- inputs: {"age_days": 3960, "days_push": 13, "days_rel": 96, "gap_med": 92, "n_releases_24m": 6}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 25888, forks 2394 (observed 2026-08-28T04:11:38.706421+00:00)

## What it is
Redoc is an open-source tool that generates beautiful, responsive API reference documentation from OpenAPI/Swagger definitions. It is distributed as a CLI tool, Docker image, HTML tag, and React component, featuring a three-panel layout with search, docs, and code examples.

## Use cases
- generate api documentation from openapi spec
- render swagger yaml as html docs
- build static api reference site
- embed api docs in react app
- create interactive api reference with code samples
- document rest api for developers

## When to choose
- you have an OpenAPI 3.x or Swagger 2.0 definition and want polished reference docs
- you want a static HTML output or React component integration
- you need a responsive three-panel docs layout with search and code samples

## When to avoid
- you need docs for non-OpenAPI sources like AsyncAPI or GraphQL today
- you want highly custom layouts beyond Redoc's theming options
- you need a full docs platform with guides and versioning rather than an API reference renderer

## Facets
- artifact type: library
- maturity: active
- function: api-documentation, documentation, static-site-generator, ui-components, cli
- domain: web-development, developer-tools, documentation
- platform: cli, browser
- tags: openapi, swagger, api-reference, react, redoc, openapi3, documentation-generator, api-documentation, nodejs, web-server, docker

## Member repositories
- Redocly/redoc (main) score 86

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:11:38.706421+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-29T16:55:57.979815+00:00, confidence not recorded.
  - readme: https://github.com/Redocly/redoc (fetched 2026-08-28T04:11:38.706421+00:00, sha 7bfed44c6dad)
  - homepage: https://redocly.github.io/redoc/ (fetched 2026-08-29T07:52:43.606537+00:00, sha 481a4d87d2f8)
- Data as of 2026-08-30T08:39:29.467469+00:00.