How redocly/redoc works
Redoc turns OpenAPI/Swagger, AsyncAPI, and GraphQL definitions into interactive API documentation for React or HTML embedding. The main workflow is specification input, format-specific adaptation, and documentation rendering, with navigation, search, schema detail, examples, and MCP documentation as distinct capabilities. The graph follows documented capabilities and visible source references; several adapter and rendering internals were not sampled, so their internal call paths are not asserted.
Main entry points: Redoc.tsx Redoc entry points · pages Documentation pages · openapi OpenAPI adapter · ItemContentRenderer.tsx Content rendering
Components 20
Specification adapters
- OpenAPI adapter
src/adapters/openapi - AsyncAPI adapter
src/adapters/asyncapi - GraphQL adapter
src/adapters/graphql
Documentation UI
- Redoc entry points
src/Redoc.tsx - Documentation pages
src/pages - Content rendering
src/components/ItemContent/ItemContentRenderer.tsx - Schema views
src/components/Schema/SchemaView.tsx - Examples and panels
src/components/panels - MCP documentation
src/components/Mcp
Navigation and discovery
- Side menu
src/components/SideMenu/SideMenu.tsx - Route resolution
src/utils/routing.ts - Search
src/services/search - Deep links
src/utils/deep-link.ts
Shared application state
- Document models
src/types - Application state
src/jotai/app.ts - API document store
src/jotai/store.ts
Supporting services
- Code samples
src/services/code-samples - GraphQL query samples
src/utils/graphql-samples.ts
Other components
- API author
- API definition
Connections 18
- API author → API definition: provides
README.md - API definition → Redoc entry points: documents from
README.md - Redoc entry points → OpenAPI adapter: supports
README.md - Redoc entry points → AsyncAPI adapter: supports
README.md - Redoc entry points → GraphQL adapter: supports
README.md - Redoc entry points → Documentation pages: renders docs
- Documentation pages → Content rendering: renders content
- Documentation pages → Side menu: shows navigation
README.md - Documentation pages → Examples and panels: shows examples
README.md - OpenAPI adapter → MCP documentation: documents extension
README.md - OpenAPI adapter → Code samples: provides samples
README.md - Content rendering → Schema views: renders schemas
- GraphQL query samples → Examples and panels: generates query sample
src/components/panels/ExampleItem/GraphQLQueryItem.tsx - Side menu → Route resolution: resolves active route
- Search → Documentation pages: searches documentation
README.md - Application state → API document store: shares document state
src/jotai/app.ts - Deep links → Schema views: supports deep links
- Document models → API document store: defines document models
src/jotai/store.ts