Any interest in supporting `AsyncAPI`?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Currently evaluating some options for api documentation, for now we just need openapi docs, but in the future we might want to add asyncapi
redoc looks a bit nicer in terms of ux, but https://github.com/Mermade/widdershins already supports AsyncAPI, so was wondering if you had any plans for supporting it in the (near) future
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
Start by reviewing Redoc’s existing OpenAPI documentation support and the AsyncAPI specification linked in the issue. Compare the requested capability with Widdershins’ AsyncAPI support, then clarify the supported scope and acceptance criteria with maintainers; no files or tests are named, so the completion boundary is not yet defined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100