How can I enforce naming conventions on spring rest controllers?

Question

For our REST API we have standardized on using hyphen case, i.e. GET /store-users?first-name=dan and not GET /storeUsers?firstName=dan

How can we enforce this naming convention as developers keep adding non compliant URLs to the application. Some static analysis of the spring rest controller annotations that would fail the maven build would be ideal.

Answer 1

A Simple Unit Test should do:

@Autowired
private ApplicationContext applicationContext;

@Test
public void allEndpointsShouldBeKebabCase() {
    RequestMappingHandlerMapping requestMappingHandlerMapping = applicationContext.getBean(RequestMappingHandlerMapping.class);
    var methodMap = requestMappingHandlerMapping.getHandlerMethods();
    //Insert your endpoint path checks here
}

Answer 2

you have at least 3 options:

• in tests let spring create your context, get all the generated urls, assert them, fail the test if assertion fails (something like user @vuongdt23 suggested)

• use ArchUnit and scan your classes, annotations, assert them, fail the test

• create custom plugin / checks for static analysis tool (sonar? checkstyle?) and plug it into your CI/CD pipeline

imho, doing it in tests instead of external static analyis tool would be the easiest way