spring-projects / spring-projects/spring-modulith
OpenAPI integration for Documentation
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.2k
- Forks
- 222
- PR merge metrics
- No merged PRs in 30d
Description
Oliver just asked me to open this ticket while presenting spring modulith at JUG Münster, so here it is:
It may be of value if the already great documentation support could also integrate possible OpenAPI definitions, for each module and/or for all modules, so not only the controllers, but kindof an integration of the OpenAPI frontend ("swagger-like").
Happy to discuss this proposal in more detail in the future, for now I'll listen again.
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 files, tests, or entry points are named. Start by reviewing the existing documentation support and how the project exposes module and controller information, then clarify whether the goal is OpenAPI definitions per module, for all modules, or both. Done should include an agreed scope for integrating a Swagger-like OpenAPI frontend.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100