asyncapi / asyncapi/asyncapi-react

GSoC 2026 Project Idea: Improving the AsyncAPI React Component

Open
#1,214 11 comments 5 reactions 0 assignees View on GitHub
gsoc
Dominant language
TypeScript
Stars
243
Forks
182
Avg merge
3d 6h
Merged PRs (30d)
11

Description

## Problem Statement

The official AsyncAPI React component allows developers to render and validate documentation for asynchronous APIs defined using the AsyncAPI specification. It supports extensive customization, enabling consumers to fully restyle the rendered output using their own design systems.

Despite its wide adoption across the AsyncAPI ecosystem, the component faces several growing challenges:

- Limited and unclear extensibility patterns for advanced customization use cases
- Rising maintenance overhead as new features and edge cases are introduced
- Tight coupling with the AsyncAPI Parser, even when using the `no-parser` distribution

This project aims to improve the **usability, extensibility, and maintainability** of the official AsyncAPI React component, while establishing a clear path for long-term ownership and sustained community contribution.

## Goals & Deliverables

By the end of GSoC, the contributor will deliver the following:

### Core Deliverables
- Refactor and improve the AsyncAPI React component codebase for better clarity, maintainability, and scalability
- Improve rendering support and interoperability, with a particular focus on framework integrations (including Angular)
- Make `no-parser` rely only on Parser Types for valid distribution
- Add proper and well-documented support for the `no-parser` integration
- Design and document clear extension points that allow consumers to customize rendering and behavior without tightly coupling to internal APIs
- Implement an Operation extension that consumers can easily plug in to test REST and Websocket APIs
- Improve error handling for extensions

### Sustainability & Ownership
- Reduce technical debt and clearly define ownership boundaries within the codebase
- Gradually transition project responsibilities to the GSoC contributor, with a focus on long-term maintainership

## Expected Timeline
- This project follows a 16-week GSoC timeline, averaging approximately 22 hours per week.

## Skills Required
- JavaScript / TypeScript
- React
- Familiarity with component libraries and design systems
- Understanding of API specifications (AsyncAPI, OpenAPI, or similar)
- Experience with documentation tooling (or willingness to learn)

## Mentor/s
- @AceTheCreator

**Availability:** Regular async support with weekly syncs

Contributor guide

Open the contributing guide

Research direction

No specific files or tests are named. Start by reading the AsyncAPI React component codebase and the no-parser integration, then map the framework-integration and extension requirements. Done means the refactoring, Angular interoperability, documented no-parser support, extension points, Operation extension, and improved extension error handling are delivered.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, react, typescript
Domain
documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.