spring-projects / spring-projects/spring-modulith
spring-modulith-observability breaks RestControllers implementing an Interface
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.2k
- Forks
- 222
- PR merge metrics
- No merged PRs in 30d
Description
When the spring-modulith-observability dependency is present, RestControllers that implement any interface are no longer serving their endpoints or apear in the OpenAPI documentation (Swagger).
This is not limited to interfaces with Rest Annotations (like @GetMapping), or OpenAPI Annotations, but also to interfaces that are not related to the REST API, including empty marker interfaces.
The expected behavior is, that the spring-modulith-observability doesn't have an effect on the availability of RestControllers implementing an interface.
Reproducer https://github.com/gmuecke/spring-modulith-observability-reproducer
Spring Modulith: 1.2.0, 1.1.5
Spring Boot: 3.3.0, 3.2.6
JDK 21
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 spring-modulith-observability reproducer and run it against the listed Spring Modulith and Spring Boot versions. Compare RestControllers that implement interfaces with and without the dependency, checking endpoint availability and OpenAPI documentation; done means interface-implementing controllers work in both cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring, spring-boot
- Domain
- api, backend, observability
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100