Add Code Examples to the Swagger Pages
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 28
- Forks
- 25
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 20
Description
Is your feature request related to a problem? Please describe.
Enable code examples in the swagger UI. This would allow end users to select a preferred language and it generate a quick sample of the code. For users that may want a single endpoint or two and do not need client libraries for this.
Describe the solution you'd like
We will most likely need to update javalin (@MikeNeilson ?)
When we go through #930 we could also work on adding this
Describe alternatives you've considered
Linking to various docs for client libraries
Additional context
Requests by public / others for code samples
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
Review the Swagger UI integration and the Javalin reference mentioned in the issue, then check #930 for related scope. Done means Swagger pages let users select a language and generate a code sample for an endpoint.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100