softwaremill / softwaremill/tapir
Support for JMS documentation using AsyncAPI
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.5k
- Forks
- 468
- Avg merge
- 5h 37m
- Merged PRs (30d)
- 34
Description
We are developing a service which is written in Scala and has a JMS 1.1 messaging API, with the intention of using the Amazon SQS implementation in production (we are using Softwaremill's ElasticMQ for development). We have hand-crafted some AsyncAPI documents for our users but would love to be able to auto-generate these from our JSON message case classes (we are using Circe). I was very excited to discover tapir as it seems to be doing most of what we need to achieve this, but it seems it doesn't support the JMS 1.1 protocol for AsyncAPI documentation. Am I missing something? If not, how difficult would it be to implement this? I'm thinking this might be something our organisation could contribute to your project.
Contributor guide
No contributing guide indexed for this repository
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
Review tapir's existing AsyncAPI documentation support and the relevant Scala message-schema generation paths; the issue names no files or tests. Confirm what is needed for JMS 1.1 and verify that generated documentation covers the stated case-class and JSON message scenario for the intended SQS-compatible use case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- backend, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100