Spring Boot를 이용한 RESTful Web Services 개발 [섹션 4] - Spring Boot API 사용

dongwooklee96 commented 3 years ago

Level3 단계의 REST API 구현을 위한 HATEOAS 적용

현재 리소스와 연관된 (호출 가능한) 자원 상태 정보를 제공한다.
HATEOAS를 사용하려면, pom.xml 파일에 아래와 같은 정보를 입력한다.

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-hateoas</artifactId>
            <scope>test</scope>
</dependency>

    @GetMapping("/users/{id}")
    public Resource<User> retriveUser(@PathVariable int id) {
        User user = service.findOne(id);

        if (user == null) {
            throw new UserNotFoundException(String.format("ID[%s] not found", id));
        }

        // HATEOAS
        Resource<User> resource = new Resource<>(user);

        ControllerLinkBuilder linkTo = ControllerLinkBuilder.linkTo(
            ControllerLinkBuilder.methodOn(this.getClass()).retrieveAllUsers());
        resource.add(linkTo.withRel("all-users"));

        return resource;
    }

위의 코드가 너무 길기 때문에 import 문을 static으로 하게 되면 아래와 같이 줄일 수 있다.

import static org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo;
import static org.springframework.hateoas.mvc.ControllerLinkBuilder.methodOn;
...
    @GetMapping("/users/{id}")
    public Resource<User> retriveUser(@PathVariable int id) {
        User user = service.findOne(id);

        if (user == null) {
            throw new UserNotFoundException(String.format("ID[%s] not found", id));
        }

        // HATEOAS
        Resource<User> resource = new Resource<>(user);

        //    ControllerLinkBuilder linkTo = ControllerLinkBuilder.linkTo(
         //   ControllerLinkBuilder.methodOn(this.getClass()).retrieveAllUsers());

         ControllerLinkBuilder linkTo = linkTo(methodOn(this.getClass()).retrieveAllUsers());

        resource.add(linkTo.withRel("all-users"));

        return resource;
    }

하나의 리소스에서 파생된 추가 정보를 얻어오는 것을 확인할 수 있다.
개발자가 해야할 일은 늘어나지만, API를 사용하는 사용자 입장에서는 편리하게 사용할 수 있다.

dongwooklee96 commented 3 years ago

REST API Documentation을 위한 Swagger 사용

pom.xml 파일에 의존성 파일을 추가해준다.

package com.example.restfulwebservice.config;

import org.springframework.beans.factory.annotation.Configurable;
import org.springframework.context.annotation.Bean;

import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configurable
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2);
    }
}

스프링 설정 파일을 하나 생성한 후에, 위의 내용을 입력한다.

dongwooklee96 commented 3 years ago

그리고 나서 다음과 같은 주소로 접속하면 스웨거 도큐먼트 화면이 출력 된다.

http://localhost:8088/swagger-ui/index.html

dongwooklee96 commented 3 years ago

http://localhost:8088/v2/api-docs

또한 다음 주소로 접속하면, 스웨거 문서를 수정할 수 있는 화면이 나타난다.

자세한 설명은 아래 링크를 참조한다

dongwooklee96 commented 3 years ago

REST API Monitoring을 위한 Actuator 설정

pom.xml 파일에 아래와 같은 내용을 추가한다.

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
            <version>2.4.5</version>
</dependency>

http://localhost:8088/acturator 위의 링크에 접속하면 아래와 같은 화면을 볼 수 있다.