IntelliJ Code Snippet

IntelliJ Code Snippet을 사용하면 편리하고 빠르게 코드를 작성할 수 있습니다.

이번 글에서는 저희 프로젝트에서 사용하면 편할 코드 스니펫을 소개하겠습니다.

IntelliJ Code Snippet 등록 방법

setting -> live template -> Java로 이동해서 Live Template을 추가합니다.

Test

테스트 코드를 작성할 때 사용하는 템플릿 입니다.

+) 언어 설정을 Java로 맞춰줘야 합니다. 아래의 Change 칸에서 설정이 가능합니다.

Template text에는 아래 내용을 입력해주세요.

@org.junit.jupiter.api.Test
@org.junit.jupiter.api.DisplayName("$TEST_NAME$")
public void $METHOD_NAME$() throws Exception {
  //given
  $END$
  //when
  
  //then
  org.assertj.core.api.Assertions.assertThat(true);
}

Edit variable을 눌러서 변수를 설정해줍니다.

Name	Expression	Default value
TEST_NAME		"test"
METHOD_NAME	regularExpression(spacesToUnderscores(TEST_NAME), "[.|,|(|)|?]", "")	"methodName"

@Test
@DisplayName("유효한 요청일 경우 게시글 생성은 성공한다.")
public void 유효한_요청일_경우_게시글_생성은_성공한다() throws Exception {
  //given
        
  //when
        
  //then
   assertThat(true);
}

Rest Docs

api 문서 (adoc)

이번에는 언어 설정을 AsciiDoc file로 설정합니다.

Template text에는 아래 내용을 입력해주세요.

== *api 이름*

=== 요청

==== Request

include::{snippets}/$API_NAME$/http-request.adoc[]

==== Request Cookies

include::{snippets}/$API_NAME$/request-cookies.adoc[]

==== Path Parameters

include::{snippets}/$API_NAME$/path-parameters.adoc[]

==== Query Parameters

include::{snippets}/$API_NAME$/query-parameters.adoc[]

==== Request Fields

include::{snippets}/$API_NAME$/request-fields.adoc[]

==== Request Parts

include::{snippets}/$API_NAME$/request-parts.adoc[]

=== 응답

==== Response

include::{snippets}/$API_NAME$/http-response.adoc[]

==== Response Fields

include::{snippets}/$API_NAME$/response-fields.adoc[]

환경 변수 설정도 위 처럼 해줍니다.

스니펫으로 생성된 템플릿에 rest docs에서 설정했던 docs 이름을 입력합니다. 그리고 api의 스펙에 맞게 필요없는 명세는 지우면 됩니다.

controller test (rest docs)

작성중...