REST API(9) Spring REST Docs - Self - Descriptive Message 적용

게시 2024/03/01 업데이트 2024/03/03

By hantaejun 16 분읽는 시간

Spring REST Docs 소개

Spring REST Docs 프로젝트는 Spring MVC Test를 사용해서 문서의 snippet(REST API의 문서 조각)들을 생성할 때 유용한 기능을 제공해주는 기능이다.
Test를 실행할 때 사용한 요청(Request)와 응답(Response), 응답에 실려있는 헤더(Header) 등의 정보를 사용해 snippet(문서 조각)을 만들 수 있다. 나중에 이 snippet들을 모아서 REST API documentation(HTML)을 완성할 수 있다.
기본적으로 Spring REST docs는 기본적으로 Asciidoctor라는 툴을 사용한다. 이 Asciidoctor를 사용하면 plain text로 작성한 문서를 Asciidoc이라는 특별한 문법(마크다운이랑 비슷한)에 맞춰 snippet들을 만들고, 이를 조합해서 조합해서 HTML 문서로 만들어 준다.
우리가 MockMVC를 통해 만든 Test들을 REST docs와 연동할 수 있다.

Spring REST Docs 적용

이제 Spring REST Docs를 우리의 API에 적용시켜 보자.

구현 Package 및 Class

EventControllerTests 수정 (1)

  
// import 생략
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs; // 추가(1)


import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; // 추가(2)


@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
@AutoConfigureRestDocs // 추가(1)
public class EventControllerTests {
    @Autowired
    MockMvc mockMvc;
    @Autowired
    ObjectMapper objectMapper;

    @Test
    @TestDescription("정상적으로 이벤트를 생성하는 테스트")
    public void createEvent() throws Exception{
        EventDto event = EventDto.builder()
                .name("Spring")
                .description("REST API Development With Spring")
                .beginEnrollmentDateTime(LocalDateTime.of(2024,02,19,14,21))
                .closeEnrollmentDateTime(LocalDateTime.of(2024,02,20,14,21))
                .beginEventDateTime(LocalDateTime.of(2024,02,21,14,21))
                .endEventDateTime(LocalDateTime.of(2024,02,22,14,21))
                .basePrice(100)
                .maxPrice(200)
                .limitOfEnrollment(100)
                .location("강남역 D2 스타트업 팩토리")
                .build();

        mockMvc.perform(post("/api/events/")
                        .contentType(MediaType.APPLICATION_JSON_UTF8)
                        .accept(MediaTypes.HAL_JSON)
                        .content(objectMapper.writeValueAsString(event))
                )
                .andDo(print())
                .andExpect(status().isCreated())
                .andExpect(jsonPath("id").exists())
                .andExpect(header().exists(HttpHeaders.LOCATION))
                .andExpect(header().string(HttpHeaders.CONTENT_TYPE, MediaTypes.HAL_JSON_UTF8_VALUE))
                .andExpect(jsonPath("free").value(false))
                .andExpect(jsonPath("offline").value(true))
                .andExpect(jsonPath("eventStatus").value(EventStatus.DRAFT.name()))
                .andExpect(jsonPath("_links.self").exists())
                .andExpect(jsonPath("_links.query-events").exists())
                .andExpect(jsonPath("_links.update-event").exists())
                .andDo(document("create-event")); // 추가(2)
        ;
    }

    // 이 외 테스트 코드 생략
    
}

@AutoConfigureRestDocs : 이 어노테이션을 통해 Spring REST Docs를 자동 설정 할 수 있다..
.andDo(document("create-event")); : 아래와 같이 ./target/generated-snippets/create-event/디렉토리 내에 문서가 생성된다.

결과 (1)

테스트 코드를 실행하면 다음과 같이 문서가 생성되는 것을 확인할 수 있다.

위 REST Docs 파일 하나만 예로 살펴보자. 출력 값이 Formating이 안되어 보기 불편한 것을 확인할 수 있다.
이를 Formating하려면 RestDocMockMvc를 커스마이징하면 된다. 우선, RestDocsMockMvcConfigurationCustomizer를 구현한 빈을 등록하자.

RestDocsConfiguration 생성

우선 RestDocsMockMvcConfigurationCustomizer를 빈으로 등록하기 위해 Rest Docs 환경 설정을 해줄 RestDocsConfiguration 클래스 파일을 생성해준다.

  
package me.hantomas.restapi.common;

import org.springframework.boot.test.autoconfigure.restdocs.RestDocsMockMvcConfigurationCustomizer;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer;

import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;

@TestConfiguration
public class RestDocsConfiguration {

    @Bean
    public RestDocsMockMvcConfigurationCustomizer restDocsMockMvcConfigurationCustomizer() {
        return configurer -> configurer.operationPreprocessors()
                .withRequestDefaults(prettyPrint())
                .withResponseDefaults(prettyPrint());
    }
}

prettyPrint()메소드를 통해 출력 문을 보기 좋게 formating 한다.
위 코드에서는 Lamda표현식을 썼는데 이는 따로 블로그에 정리해보겠다.

EventControllerTests 수정 (2)

  
// import 생략
import org.springframework.context.annotation.Import; // 추가


@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
@AutoConfigureRestDocs
@Import(RestDocsConfiguration.class) // 추가
public class EventControllerTests {
    @Autowired
    MockMvc mockMvc;
    @Autowired
    ObjectMapper objectMapper;

    @Test
    @TestDescription("정상적으로 이벤트를 생성하는 테스트")
    public void createEvent() throws Exception{
        EventDto event = EventDto.builder()
                .name("Spring")
                .description("REST API Development With Spring")
                .beginEnrollmentDateTime(LocalDateTime.of(2024,02,19,14,21))
                .closeEnrollmentDateTime(LocalDateTime.of(2024,02,20,14,21))
                .beginEventDateTime(LocalDateTime.of(2024,02,21,14,21))
                .endEventDateTime(LocalDateTime.of(2024,02,22,14,21))
                .basePrice(100)
                .maxPrice(200)
                .limitOfEnrollment(100)
                .location("강남역 D2 스타트업 팩토리")
                .build();

        mockMvc.perform(post("/api/events/")
                        .contentType(MediaType.APPLICATION_JSON_UTF8)
                        .accept(MediaTypes.HAL_JSON)
                        .content(objectMapper.writeValueAsString(event))
                )
                .andDo(print())
                .andExpect(status().isCreated())
                .andExpect(jsonPath("id").exists())
                .andExpect(header().exists(HttpHeaders.LOCATION))
                .andExpect(header().string(HttpHeaders.CONTENT_TYPE, MediaTypes.HAL_JSON_UTF8_VALUE))
                .andExpect(jsonPath("free").value(false))
                .andExpect(jsonPath("offline").value(true))
                .andExpect(jsonPath("eventStatus").value(EventStatus.DRAFT.name()))
                .andExpect(jsonPath("_links.self").exists())
                .andExpect(jsonPath("_links.query-events").exists())
                .andExpect(jsonPath("_links.update-event").exists())
                .andDo(document("create-event"));
        ;
    }

    // 이 외 테스트 코드 생략
    
}

@Import(RestDocsConfiguration.class)어노테이션을 추가하여 다른 빈 설정 파일인 RestDocsConfigurateion.class를 import해서 사용한다.

결과 (2)

Spring Rest Docs : 링크, 요청/응답의 필드와 헤더 문서화

~~요청 본문 문서화~~(완료)
~~응답 본문 문서화~~(완료)
링크 문서화
self
query-events
update-event
profile 링크 추가
요청 헤더 문서화
요청 필드 문서화
응답 헤더 문서화
응답 필드 문서화

현재 요청/응답 본문을 문서화하는 작업까지 완료되었다. 이제 링크, 요청/응답의 필드와 헤더들을 문서화하는 작업을 해보자.

링크 문서화

  
// import 생략
import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel; // 추가
import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.links; // 추가


@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
@AutoConfigureRestDocs
@Import(RestDocsConfiguration.class) // 추가
public class EventControllerTests {
    @Autowired
    MockMvc mockMvc;
    @Autowired
    ObjectMapper objectMapper;

    @Test
    @TestDescription("정상적으로 이벤트를 생성하는 테스트")
    public void createEvent() throws Exception{
        EventDto event = EventDto.builder()
                .name("Spring")
                .description("REST API Development With Spring")
                .beginEnrollmentDateTime(LocalDateTime.of(2024,02,19,14,21))
                .closeEnrollmentDateTime(LocalDateTime.of(2024,02,20,14,21))
                .beginEventDateTime(LocalDateTime.of(2024,02,21,14,21))
                .endEventDateTime(LocalDateTime.of(2024,02,22,14,21))
                .basePrice(100)
                .maxPrice(200)
                .limitOfEnrollment(100)
                .location("강남역 D2 스타트업 팩토리")
                .build();

        mockMvc.perform(post("/api/events/")
                        .contentType(MediaType.APPLICATION_JSON_UTF8)
                        .accept(MediaTypes.HAL_JSON)
                        .content(objectMapper.writeValueAsString(event))
                )
                .andDo(print())
                .andExpect(status().isCreated())
                .andExpect(jsonPath("id").exists())
                .andExpect(header().exists(HttpHeaders.LOCATION))
                .andExpect(header().string(HttpHeaders.CONTENT_TYPE, MediaTypes.HAL_JSON_UTF8_VALUE))
                .andExpect(jsonPath("free").value(false))
                .andExpect(jsonPath("offline").value(true))
                .andExpect(jsonPath("eventStatus").value(EventStatus.DRAFT.name()))
                .andExpect(jsonPath("_links.self").exists())
                .andExpect(jsonPath("_links.query-events").exists())
                .andExpect(jsonPath("_links.update-event").exists())
                .andDo(document("create-event",
                        links( // 추가
                                linkWithRel("self").description("link to self"),
                                linkWithRel("query-events").description("link to query events"),
                                linkWithRel("update-event").description("link to update event")
                        )
                                
                ))
        ;
    }

    // 이 외 테스트 코드 생략
    
}

links() + linkWithRel() : 링크와 관련된 문서조각("links.adoc")을 생성한다.

결과

요청/응답의 필드와 헤더 문서화

위와 같은 방식으로 요청과 응답의 필드와 헤더를 문서화 할 수 있다.

  
// import 생략  
import static org.springframework.restdocs.headers.HeaderDocumentation.*;  
import static org.springframework.restdocs.payload.PayloadDocumentation.*;


@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
@AutoConfigureRestDocs
@Import(RestDocsConfiguration.class) // 추가
public class EventControllerTests {
    @Autowired
    MockMvc mockMvc;
    @Autowired
    ObjectMapper objectMapper;

    @Test
    @TestDescription("정상적으로 이벤트를 생성하는 테스트")
    public void createEvent() throws Exception{
        EventDto event = EventDto.builder()
                .name("Spring")
                .description("REST API Development With Spring")
                .beginEnrollmentDateTime(LocalDateTime.of(2024,02,19,14,21))
                .closeEnrollmentDateTime(LocalDateTime.of(2024,02,20,14,21))
                .beginEventDateTime(LocalDateTime.of(2024,02,21,14,21))
                .endEventDateTime(LocalDateTime.of(2024,02,22,14,21))
                .basePrice(100)
                .maxPrice(200)
                .limitOfEnrollment(100)
                .location("강남역 D2 스타트업 팩토리")
                .build();

        mockMvc.perform(post("/api/events/")
                        .contentType(MediaType.APPLICATION_JSON_UTF8)
                        .accept(MediaTypes.HAL_JSON)
                        .content(objectMapper.writeValueAsString(event))
                )
                .andDo(print())
                .andExpect(status().isCreated())
                .andExpect(jsonPath("id").exists())
                .andExpect(header().exists(HttpHeaders.LOCATION))
                .andExpect(header().string(HttpHeaders.CONTENT_TYPE, MediaTypes.HAL_JSON_UTF8_VALUE))
                .andExpect(jsonPath("free").value(false))
                .andExpect(jsonPath("offline").value(true))
                .andExpect(jsonPath("eventStatus").value(EventStatus.DRAFT.name()))
                .andExpect(jsonPath("_links.self").exists())
                .andExpect(jsonPath("_links.query-events").exists())
                .andExpect(jsonPath("_links.update-event").exists())
                .andDo(document("create-event",
                        links(
                                linkWithRel("self").description("link to self"),
                                linkWithRel("query-events").description("link to query events"),
                                linkWithRel("update-event").description("link to update event")
                        ),
                        requestHeaders( // 추가
                                headerWithName(HttpHeaders.ACCEPT).description("accept header"),
                                headerWithName(HttpHeaders.CONTENT_TYPE).description("content type header")
                        ),
                        requestFields( // 추가
                                fieldWithPath("name").description("name of new event"),
                                fieldWithPath("description").description("description of new event"),
                                fieldWithPath("beginEnrollmentDateTime").description("date time of begin of new event"),
                                fieldWithPath("closeEnrollmentDateTime").description("date time of close of new event"),
                                fieldWithPath("beginEventDateTime").description("date time of begin of new event"),
                                fieldWithPath("endEventDateTime").description("date time of end of new event"),
                                fieldWithPath("location").description("location of new event"),
                                fieldWithPath("basePrice").description("basePrice of new event"),
                                fieldWithPath("maxPrice").description("maxPrice of new event"),
                                fieldWithPath("limitOfEnrollment").description("limit of enrollment")
                        ),
                        responseHeaders( // 추가
                                headerWithName(HttpHeaders.LOCATION).description("Location header"),
                                headerWithName(HttpHeaders.CONTENT_TYPE).description("Content type")
                        ),
                        responseFields( // 추가
                                fieldWithPath("id").description("identifier of new event"),
                                fieldWithPath("name").description("name of new event"),
                                fieldWithPath("description").description("description of new event"),
                                fieldWithPath("beginEnrollmentDateTime").description("date time of begin of new event"),
                                fieldWithPath("closeEnrollmentDateTime").description("date time of close of new event"),
                                fieldWithPath("beginEventDateTime").description("date time of begin of new event"),
                                fieldWithPath("endEventDateTime").description("date time of end of new event"),
                                fieldWithPath("location").description("location of new event"),
                                fieldWithPath("basePrice").description("basePrice of new event"),
                                fieldWithPath("maxPrice").description("maxPrice of new event"),
                                fieldWithPath("limitOfEnrollment").description("limit of enrollment"),
                                fieldWithPath("free").description("it tells if this event is free or not"),
                                fieldWithPath("offline").description("it tells if this event is offline event or not"),
                                fieldWithPath("eventStatus").description("event status")
                        )
                ))
        ;
    }

    // 이 외 테스트 코드 생략
    
}

requestHeaders() + headerWithName() : 요청 헤더와 관련된 문서조각("request-headers.adoc")을 생성한다.
requestFields() + fieldWithPath() : 요청 필드와 관련된 문서조각("request-fields.adoc")을 생성한다.
responseHedaers() + headerWithName() : 응답 헤더와 관련된 문서조각("response-headers.adoc")을 생성한다.
responseFields() + fieldWithPath() : 응답 필드와 관련된 문서조각("response-fields.adoc")을 생성한다.

결과 (실패)

우리는 링크와 관련된 정보들은 links() + linkWithRel()를 통해 문서화를 해줬다. 하지만 오류에서는 그렇지 않다고 한다. 오류에서 문서화 하지 않았다는 링크는 응답 본문(response)에 담겨져 있는 링크 정보들이다. 따라서, 응답 본문의 링크 정보 검증을 피하기 위해 우리는 일부 응답만 문서화 하는 relexedResponseFields() + fieldWithPath()를 이용하면 된다.

Relaxed 접두어
장점: 문서 일부분만 테스트 할 수 있다.
단점: 정확한 문서를 생성하지 못한다.

이러한 단점이 있기 때문에, 응답 본문에서도 링크에 대한 정보를 다 정의해 주는 것이 좋다.

결과 (relaxedResponseFields() - 성공)

결과 (성공)

Spring REST Docs 문서 빌드

이제 우리의 REST API에 대한 문서를 빌드해보자.

pom.xml

우선 pom.xml에 메이븐 플러그인을 설정하자.

  
<plugin>
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctor-maven-plugin</artifactId>
    <version>1.5.8</version>
    <executions>
        <execution>
            <id>generate-docs</id>
            <phase>prepare-package</phase>
            <goals>
                <goal>process-asciidoc</goal>
            </goals>
            <configuration>
                <backend>html</backend>
                <doctype>book</doctype>
            </configuration>
        </execution>
    </executions>
    <dependencies>
        <dependency>
            <groupId>org.springframework.restdocs</groupId>
            <artifactId>spring-restdocs-asciidoctor</artifactId>
            <version>${spring-restdocs.version}</version>
        </dependency>
    </dependencies>
</plugin>
<plugin>
    <artifactId>maven-resources-plugin</artifactId>
    <version>2.7</version>
    <executions>
        <execution>
            <id>copy-resources</id>
            <phase>prepare-package</phase>
            <goals>
                <goal>copy-resources</goal>
            </goals>
            <configuration>
                <outputDirectory>
                    ${project.build.outputDirectory}/static/docs
                </outputDirectory>
                <resources>
                    <resource>
                        <directory>
                            ${project.build.directory}/generated-docs
                        </directory>
                    </resource>
                </resources>
            </configuration>
        </execution>
    </executions>
</plugin>

asciidoctor-maven-plugin으로 generated-docs에 index.html을 생성한다.
- prepare-package라는 phase가 asciidoc을 처리한다.
  - process-asciidoc src.main.asciidoc 디렉토리 안에 들어있는 모든 asciidoc문서를 html로 만들어준다.
maven-resources-plugin은 static.docs에 위의 index.html를 옮겨준다.
- copy-resources가 ${project.build.outputDirectory}/static/docs에 ${project.build.directory}/generated-docs에 있는 모든 파일을 copy한다.
생성후 복사를 해야하기 때문에 위 플러그인 선언 순서가 중요하다.
위 과정들은 소스 디렉토리에서 일어난 것이 아닌 빌드 디렉토리 내에서 일어난 것임을 기억하자.
- 빌드 = 소스코드에서 컴파일 된 파일들을 적절한 classpath 밑으로 넣어주는 행위

문서 파일 생성

아래와 같이 디렉토리를 만들어 index.adoc 파일을 만들어 준다.

Maven packaging

Maven의 Lifecycle중 package를 실행시켜주면 된다. 그럼 다음과 같은 경로에 파일이 생성된 것을 확인할 수 있다.
target 디렉토리를 살펴보면 static 밑에 docs 안에 파일이 생성된 것을 확인할 수 있다.
이는 실제 웹서버를 띄우면, http://localhost:8080/docs/index.html을 통해서도 문서에 접근이 가능하다는 것을 보여준다.

profile 링크 추가

본문에 대한 문서(docs) 링크인 profile 링크를 추가해보자.

EventController

  
// import 생략
import org.springframework.hateoas.Link;  


@Controller
@RequestMapping(value = "/api/events", produces = MediaTypes.HAL_JSON_UTF8_VALUE)
public class EventController {
    private final EventRepository eventRepository;

    private final ModelMapper modelMapper;

    private final EventValidator eventValidator;

    public EventController(EventRepository eventRepository, ModelMapper modelMapper, EventValidator eventValidator) {
        this.eventRepository = eventRepository;
        this.modelMapper = modelMapper;
        this.eventValidator = eventValidator;
    }
    @PostMapping
    public ResponseEntity createEvent(@RequestBody @Valid EventDto eventDto, Errors errors){

        if (errors.hasErrors()){
            return ResponseEntity.badRequest().body(errors);
        }

        eventValidator.validate(eventDto, errors);
        if (errors.hasErrors()){
            return ResponseEntity.badRequest().body(errors);
        }

        Event event = modelMapper.map(eventDto, Event.class);
        event.update();
        Event newEvent = this.eventRepository.save(event);

        ControllerLinkBuilder selfLinkBuilder = linkTo(EventController.class).slash(newEvent.getId());
        URI createdUri = selfLinkBuilder.toUri();
        EventResource eventResource = new EventResource(newEvent);
        eventResource.add(linkTo(EventController.class).withRel("query-events"));
        eventResource.add(selfLinkBuilder.withRel("update-event"));
        eventResource.add(new Link("/docs/index.html#resources-events-create").withRel("profile")); // 추가
        return ResponseEntity.created(createdUri).body(eventResource);
    }
}

EventControllerTests

  
// import 생략  
@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
@AutoConfigureRestDocs
@Import(RestDocsConfiguration.class)
public class EventControllerTests {
    @Autowired
    MockMvc mockMvc;
    @Autowired
    ObjectMapper objectMapper;

    @Test
    @TestDescription("정상적으로 이벤트를 생성하는 테스트")
    public void createEvent() throws Exception{
        EventDto event = EventDto.builder()
                .name("Spring")
                .description("REST API Development With Spring")
                .beginEnrollmentDateTime(LocalDateTime.of(2024,02,19,14,21))
                .closeEnrollmentDateTime(LocalDateTime.of(2024,02,20,14,21))
                .beginEventDateTime(LocalDateTime.of(2024,02,21,14,21))
                .endEventDateTime(LocalDateTime.of(2024,02,22,14,21))
                .basePrice(100)
                .maxPrice(200)
                .limitOfEnrollment(100)
                .location("강남역 D2 스타트업 팩토리")
                .build();

        mockMvc.perform(post("/api/events/")
                        .contentType(MediaType.APPLICATION_JSON_UTF8)
                        .accept(MediaTypes.HAL_JSON)
                        .content(objectMapper.writeValueAsString(event))
                )
                .andDo(print())
                .andExpect(status().isCreated())
                .andExpect(jsonPath("id").exists())
                .andExpect(header().exists(HttpHeaders.LOCATION))
                .andExpect(header().string(HttpHeaders.CONTENT_TYPE, MediaTypes.HAL_JSON_UTF8_VALUE))
                .andExpect(jsonPath("free").value(false))
                .andExpect(jsonPath("offline").value(true))
                .andExpect(jsonPath("eventStatus").value(EventStatus.DRAFT.name()))
                .andExpect(jsonPath("_links.self").exists())
                .andExpect(jsonPath("_links.query-events").exists())
                .andExpect(jsonPath("_links.update-event").exists())
                .andDo(document("create-event",
                        links(
                                linkWithRel("self").description("link to self"),
                                linkWithRel("query-events").description("link to query events"),
                                linkWithRel("update-event").description("link to update event"),
                                linkWithRel("profile").description("link to profile") // 추가
                        ),
                        requestHeaders(
                                headerWithName(HttpHeaders.ACCEPT).description("accept header"),
                                headerWithName(HttpHeaders.CONTENT_TYPE).description("content type header")
                        ),
                        requestFields(
                                fieldWithPath("name").description("name of new event"),
                                fieldWithPath("description").description("description of new event"),
                                fieldWithPath("beginEnrollmentDateTime").description("date time of begin of new event"),
                                fieldWithPath("closeEnrollmentDateTime").description("date time of close of new event"),
                                fieldWithPath("beginEventDateTime").description("date time of begin of new event"),
                                fieldWithPath("endEventDateTime").description("date time of end of new event"),
                                fieldWithPath("location").description("location of new event"),
                                fieldWithPath("basePrice").description("basePrice of new event"),
                                fieldWithPath("maxPrice").description("maxPrice of new event"),
                                fieldWithPath("limitOfEnrollment").description("limit of enrollment")
                        ),
                        responseHeaders(
                                headerWithName(HttpHeaders.LOCATION).description("Location header"),
                                headerWithName(HttpHeaders.CONTENT_TYPE).description("Content type")
                        ),
                        responseFields(
                                fieldWithPath("id").description("identifier of new event"),
                                fieldWithPath("name").description("name of new event"),
                                fieldWithPath("description").description("description of new event"),
                                fieldWithPath("beginEnrollmentDateTime").description("date time of begin of new event"),
                                fieldWithPath("closeEnrollmentDateTime").description("date time of close of new event"),
                                fieldWithPath("beginEventDateTime").description("date time of begin of new event"),
                                fieldWithPath("endEventDateTime").description("date time of end of new event"),
                                fieldWithPath("location").description("location of new event"),
                                fieldWithPath("basePrice").description("basePrice of new event"),
                                fieldWithPath("maxPrice").description("maxPrice of new event"),
                                fieldWithPath("limitOfEnrollment").description("limit of enrollment"),
                                fieldWithPath("free").description("it tells if this event is free or not"),
                                fieldWithPath("offline").description("it tells if this event is offline event or not"),
                                fieldWithPath("eventStatus").description("event status"),
                                fieldWithPath("_links.self.href").description("link to self"),
                                fieldWithPath("_links.query-events.href").description("link to query events"),
                                fieldWithPath("_links.update-event.href").description("link to update event"),
                                fieldWithPath("_links.profile.href").description("link to profile") // 추가
                        )
                ))
        ;
    }
}

결과 (성공)

⚙️Back-End, 🍃Spring

Spring REST Docs 소개

Spring REST Docs 적용

구현 Package 및 Class

EventControllerTests 수정 (1)

결과 (1)

RestDocsConfiguration 생성

EventControllerTests 수정 (2)

결과 (2)

Spring Rest Docs : 링크, 요청/응답의 필드와 헤더 문서화

링크 문서화

결과

요청/응답의 필드와 헤더 문서화

결과 (실패)

결과 (relaxedResponseFields() - 성공)

결과 (성공)

Spring REST Docs 문서 빌드

pom.xml

문서 파일 생성

Maven packaging

profile 링크 추가

EventController

EventControllerTests

결과 (성공)

인기 태그