mnahkies / mnahkies/openapi-code-generator
Investigate supporting async api
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 34
- Forks
- 8
- Avg merge
- 20h 27m
- Merged PRs (30d)
- 7
Description
Async API is a specification for describing event driven architecture, that aims to keep near compatibility with openapi specifications:
Part of this content has been taken from the great work done by the folks at the OpenAPI Initiative. Mainly because it's a great work and we want to keep as much compatibility as possible with the OpenAPI Specification.
It would be good to investigate adding support for this, possible templates could include:
- GCP PubSub
- AWS SNS/SQS
- Azure Service Bus
- RabbitMQ
- Kafka
- ZeroMQ
https://www.asyncapi.com/docs/tutorials/getting-started/coming-from-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
Start with the linked AsyncAPI getting-started material and compare its event-driven specification with the repository's existing OpenAPI code-generation scope. Review the listed GCP PubSub, AWS SNS/SQS, Azure Service Bus, RabbitMQ, Kafka, and ZeroMQ possibilities; done requires a scoped support plan rather than an implementation target.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100