microsoft / microsoft/vscode-spring-boot-dashboard

Add support for custom `RequestMappingHandlerMapping`

Open
#341 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
73
Forks
38
Avg merge
3d 5h
Merged PRs (30d)
15

Description

I have a custom implementation of RequestMappingHandlerMapping so that I can use @ApiVersion annotation to prefix version to the start of request endpoint by annotating either controller class or individual methods. However, this extension does not provide an option to use the custom implementation and end up with duplicate endpoints for different versions as version information would be missing without the custom implementation.

@RestController
@ApiVersion("2")
@RequestMapping("base")
public class SomeController {
  @Deprecated
  @ApiVersion("1")
  @GetMapping("endpoint") // mapped to `/v1/base/endpoint`
  ResponseEntity someOldMethodForBackwardCompatibility() { /** ... */ }

  @GetMapping("endpoint") // mapped to `/v2/base/endpoint`
  ResponseEntity newAndImprovedMethod() { /** ... */ }
}

Please add support for custom implementations of RequestMappingHandlerMapping.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing where the dashboard discovers or processes Spring Boot request mappings, using RequestMappingHandlerMapping as the entry point. Determine how a custom implementation can be selected and verify that versioned endpoints are recognized without duplicate mappings; done means custom implementations are supported for the described controller and method annotations.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring-boot
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.