Spring REST Docs - CSRF

[f1v3-dev]

🛠️ 어떤 기능인가요?

MockMvc를 사용하여 요청을 보냈을 경우, csrf 설정이 필요하다는 에러가 발생했었습니다.

이러한 문제를 해결하기 위해 코드 상에서 아래와 같이 요청시, csrf를 포함하도록 하였는데 request param에 붙어 보기 불편하다는 문제가 존재합니다.

    @BeforeEach
    void setUp(WebApplicationContext context, RestDocumentationContextProvider restDocumentation) {

        this.mockMvc = MockMvcBuilders
                .webAppContextSetup(context)
                .apply(documentationConfiguration(restDocumentation))
                .alwaysDo(MockMvcResultHandlers.print())
                .alwaysDo(restDocs)
                .addFilters(new CharacterEncodingFilter("UTF-8", true))
                .apply(springSecurity())
                .defaultRequest(post("/**").with(csrf()))
                .defaultRequest(get("/**").with(csrf()))
                .defaultRequest(patch("/**").with(csrf()))
                .defaultRequest(delete("/**").with(csrf()))
                .build();
    }

csrf에 대한 정보를 헤더로 보내는 방식으로 수정하는 것이 더 깔끔한 문서화를 만드는데 도움이 될 것 같아요!

🗒️ 작업 상세 내용

• [x] csrf를 request param이 아닌, header에 넣는 방식으로 변경하기

👀 참고할만한 자료

https://onedaythreecoding.tistory.com/entry/RestDocs-Request-parameters-with-the-following-names-were-not-documented-csrf