swagger-api / swagger-api/swagger-ui
AsyncAPI
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Content & configuration
AsyncAPI became quite popular and rendering AsyncAPI's within swagger-ui would be awesome!
From a concept point of view it is very similar to OpenAPI, see https://www.asyncapi.com/docs/getting-started/coming-from-openapi
Are there any plans to add AsyncAPI capabilities to swagger-ui?
Describe the solution you'd like
Support of AsycAPI within swagger-ui
Describe alternatives you've considered
using another tool then swagger-ui, see https://www.asyncapi.com/docs/community/tooling#documentation-generators
Additional context
- GitLab uses swagger-ui to render API specs: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21106
- I'm of course ready to add similar support for AsyncAPI based filename pattern as with OpenAPI
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No implementation files or tests are named. Start by reviewing swagger-ui's existing OpenAPI rendering path and the filename-pattern support mentioned in the issue, then compare the AsyncAPI requirements and tooling documentation. Done would mean a defined and tested approach for rendering AsyncAPI specifications, but the issue does not specify the scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100