Create custom annotation for request mapping headers spring

Question

I am using spring-boot-1.5.6. I have a controller inside I have around 8-request mapping which has common headers. Headers mentioned below are mandatory for most of the methods in the controller and mentioning all the headers looks ugly, Is there any way to generalize or custom annotation so that I don't want to replicate the headers in all the method.

@RestController
public class RestController {
  private static final Logger logger = LoggerFactory.getLogger(RestController.class);

  /**
   * Simply chooses a few headers, logs them and add them to model to
   * showHeaders view to render to the user.
   */

  @GetMapping(value="/showheaders")

  public String getHeaders(
          @RequestHeader(value="sample") String sample,
          @RequestHeader(value="sample1") String sample1,
          @RequestHeader(value="sample2") String sample2,
          @RequestHeader(value="sample3") String sample3,
          @RequestHeader(value="sample4") String sample4) {
    logger.info("Inside getHeaders() method...");
    logger.info("sample : " + sample);
    logger.info("sample1 : " + sample1);
    logger.info("sample2 : " + sample2);
    logger.info("sample3 : " + sample3);
    logger.info("sample4 : " + sample4);

  }

Expected :

@RestController
    public class RestController {
      private static final Logger logger = LoggerFactory.getLogger(RestController.class);

      /**
       * Simply chooses a few headers, logs them and add them to model to
       * showHeaders view to render to the user.
       */

      @GetMapping(value="/showheaders")

      public String getHeaders(@MyHeaders headers) {
        logger.info("Inside getHeaders() method...");
        logger.info("sample : " + sample);
        logger.info("sample1 : " + sample1);
        logger.info("sample2 : " + sample2);
        logger.info("sample3 : " + sample3);
        logger.info("sample4 : " + sample4); 

      }

I know we can use @RequestHeader Map headers but in swagger, I would like to see all the headers parameter name.so that we can pass all the headers for the methods. Using map not showing anything in swagger.

Any hint or suggestion would be appreciable.

@AmardeepBhowmick Thanks for your reply. I haven't tried yet. Could you please share the link or documentation for that? What is the benefit of that? I would like to see the header names in swagger — VelNaga
– VelNaga, Commented Sep 9, 2018 at 11:51

Shawn Alagheband · Accepted Answer · 2018-09-09 11:54:29Z

5

You can use @ModelAttribute for this purpose :

1.Create A Header Holder Class:

public class MyheaderHolder {
    private String sample;
    private String sample1;
    private String sample2;
    private String sample3;
    private String sample4;
    //getter setters
}

2.Define a ModelAttribute:

@ModelAttribute("myHeaderHolder")
public Something addSomething(@RequestHeader(value = "sample") String sample,
    @RequestHeader(value = "sample1") String sample1,
    @RequestHeader(value = "sample2") String sample2,
    @RequestHeader(value = "sample3") String sample3,
    @RequestHeader(value = "sample4") String sample4) {
    return new MyHeaderHolder(name);
}

3.Refactor getHeaders Controller to use ModelAttribute

@GetMapping(value = "/showheaders")
public String getHeaders(@ModelAttribute MyHeaderHolder myHeaderHolder) {
    logger.info("Inside getHeaders() method...");
    logger.info("sample : " + myHeaderHolder.getSample());
    logger.info("sample1 : " + myHeaderHolder.getSample1());
    logger.info("sample2 : " + myHeaderHolder.getSample2());
    logger.info("sample3 : " + myHeaderHolder.getSample3());
    logger.info("sample4 : " + myHeaderHolder.getSample4());    
}

answered Sep 9, 2018 at 11:54

Shawn Alagheband

2,23016 silver badges24 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

VelNaga Over a year ago

Thanks a lot for your answer. It is working fine but in swagger, It is showing as a request parameter instead of request headers. How can we fix it?

Shawn Alagheband Over a year ago

this seems to be an issue with swagger (github.com/springfox/springfox/issues/174), which i also already faced with it but could find any workaround, i think it is going to be worth it to raise another question for that. @VelNaga

drowny · Accepted Answer · 2018-09-09 11:54:24Z

-2

You can use @RequestHeader like this ;

@GetMapping(value="/showheaders")
    public String getHeaders(@RequestHeader Map<String, String> myHeaders) {
        logger.info("Inside getHeaders() method...");
        logger.info("sample : " + myHeaders.get("sample"));
        logger.info("sample1 : " + myHeaders.get("sample1"));
        logger.info("sample2 : " + myHeaders.get("sample2"));
        logger.info("sample3 : " + myHeaders.get("sample3"));
        logger.info("sample4 : " + myHeaders.get("sample4"));

    }

Request header are set in Map. U can get what u need.

answered Sep 9, 2018 at 11:54

drowny

2,14714 silver badges20 bronze badges

Collectives™ on Stack Overflow

Create custom annotation for request mapping headers spring

2 Answers 2

1.Create A Header Holder Class:

2.Define a ModelAttribute:

3.Refactor getHeaders Controller to use ModelAttribute

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1.Create A Header Holder Class:

2.Define a ModelAttribute:

3.Refactor getHeaders Controller to use ModelAttribute

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related