-
-
Notifications
You must be signed in to change notification settings - Fork 174
Open
Labels
gsocThis label shoudl be used for issues or discussions related to ideas for Google Summer of CodeThis label shoudl be used for issues or discussions related to ideas for Google Summer of Code
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-parserdistribution
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-parserrely only on Parser Types for valid distribution - Add proper and well-documented support for the
no-parserintegration - 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
Availability: Regular async support with weekly syncs
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
gsocThis label shoudl be used for issues or discussions related to ideas for Google Summer of CodeThis label shoudl be used for issues or discussions related to ideas for Google Summer of Code