Adding custom request header to every API in spring boot

Question

I am trying to add custom request header to every API I can do it by adding a piece of code to every API

`public ResponseDTO setNames(@RequestHeader(value="my-header",required = false HttpServletRequest httpServletRequest) throws Exception {}`

But I want this to be done automatically like we have authorisation header by default when we create a new API.How can this be done can anyone tell me a good solution

enter image description here

Do you want to add documentation to your API or use the header to make some validations in every API? — earandap, Jun 16 '22 at 23:12
**Solved** Found the solution here: https://stackoverflow.com/a/73503791/10063334 — NXT Dev, Sep 01 '22 at 12:07

score 3 · Accepted Answer · answered Jun 16 '22 at 20:12

You can use the following if you are using springdoc-openapi

@Configuration
class CustomizeSpringDoc {
    @Bean
    fun publicApi(): GroupedOpenApi {
        return GroupedOpenApi.builder()
            .group("add-auth-header")
            .addOperationCustomizer { operation, handlerMethod ->
                operation.parameters.add(
                    HeaderParameter()
                        .name("Authorization")
                        .description("Access Token")
                )
                operation
            }
            .build()
    }
}

If you are using spring-fox, you can refer back to the below link, globalRequestParameters: http://springfox.github.io/springfox/docs/current/#quick-start-guides

score 2 · Answer 2 · answered Jun 17 '22 at 16:14

For making header validation for each request, you can use a Filter or HandlerInterceptors.

Filters intercept requests before they reach the DispatcherServlet, making them ideal for coarse-grained tasks such as:

Authentication
Logging and auditing
Image and data compression
Any functionality we want to be decoupled from Spring MVC

HandlerIntercepors, on the other hand, intercepts requests between the DispatcherServlet and our Controllers. This is done within the Spring MVC framework, providing access to the Handler and ModelAndView objects.

This reduces duplication and allows for more fine-grained functionality such as:

Handling cross-cutting concerns such as application logging
Detailed authorization checks
Manipulating the Spring context or model

Source: https://www.baeldung.com/spring-mvc-handlerinterceptor-vs-filter

score 0 · Answer 3 · answered Jun 17 '22 at 05:00

You can make use of OpenAPI specification (previously Swagger specification) in your Spring-boot project, where in , you define your APIs along with Request/Response headers as well as any error model you may want to return or any other custom field you want to capture!

By defining, you will have privilege of mentioning attributes such as required, minLength, maxLength etc

The openAPI plugin will take care of rest of the things!

You may refer these links to have a glance!

https://www.javainuse.com/spring/boot_swagger3

https://www.baeldung.com/spring-rest-openapi-documentation

Adding custom request header to every API in spring boot

3 Answers3