4. Spring Boot API 사용

REST API Level 3를 위한 HATEOAS 설정

HATEOAS

Hypermedia As the Engine Of Application State

현재 리소스와 연관된(호출 가능한) 자원 상태 정보를 제공

REST API 설계 단계

1. The Swamp of POX : 특정한 웹 프로토콜을 통해서 컴퓨터가 가지고 있는 자원을 의미 없이 전달
2. Resources
3. HTTP Verbs : http 상태 메소드를 이용
4. Hypermedia controls : 리소스의 정보를 추가적으로 사용할 수 있는 리소스와 함께 전달

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

IntelliJ에서 검색

shift key 2번 누르기 → pom.xml 선택

버전별 HATEOAS implementation

pom.xml 제일 상단을 보면 스프링부트 버전 확인 가능

<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.6.3</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>

1. spring 2.1.8 RELEASE

• Resource : 만들고자 하는 추가 자원을 Resouce 객체로 넣음
• ControllerLinkBuilder : 링크해줌

@GetMapping("/users/{id}")
public Resource<User> retrieveUser(@PathVariable int id){
// HATEOAS
// "all-users", SERVER_PATH + "/users"
// retrieveAllUsers
	Resource<User> resource = new Resource<>(user);
	ControllerLinkBuilder linkTo = linkTo(methodOn(this.getClass()).retrieveAllUsers());
	resource.add(linkTo.withRel("all-users");

	return resource;
}

1. spring 2.2

• Resource → EntityModel
• ControllerLinkBuilder → WebMvcLinkBuilder

@GetMapping("/users/{id}")
public Resource<User> retrieveUser(@PathVariable int id){
// HATEOAS
// "all-users", SERVER_PATH + "/users"
// retrieveAllUsers
	EntityModel<User> model= new EntityModel<>(user);
	WebMvcLinkBuilder linkTo = linkTo(methodOn(this.getClass()).retrieveAllUsers());
	model.add(linkTo.withRel("all-users"); // 리소스 이름 : all-users

	return model;
}

retrieveAllUsers()와 all-users 연동 → /users와 all-users mapping

REST API Documentation을 위한 Swagger 설정

Swagger

API 설계, 빌드, 문서화, 사용에 도움을 주는 오픈소스 프레임워크

<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-boot-starter</artifactId>
      <version>3.0.0</version>
</dependency>

<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>3.0.0</version>
</dependency>

spring boot 2.6 버전 이후에 spring.mvc.pathmatch.matching-strategy 값이 ant_path_matcher에서 path_pattern_parser로 변경되면서 몇몇 라이브러리(swagger포함)에 오류가 발생한다. 아래 값을 application.yml에 추가해줘야 함.

Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException: Cannot invoke "org.springframework.web.servlet.mvc.condition.PatternsRequestCondition.getPatterns()" because "this.condition" is null

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

⇒ 하지만 얘는 actuator를 지원하지 않는다(actuator는 pathpattern-based parsing을 사용하기 때문)

@Configuration
@EnableSwagger2
public class SwaggerConfig {
	@Bean
	public Docket api(){
		return new Docket(DocumentationType.SWAGGER_2);
	}
	// SWAGGER 2
	// All the paths
	// All the apis
}

@Data
@AllArgsConstructor
@NoArgsConstructor // 디폴트 생성자 생성
@ApiModel(description = "사용자 상세 정보를 위한 도메인 객체")
public class User {
	private Integer id;

	@Size(min=2, message = "Name은 2글자 이상 입력해주세요.")
	@ApiModelProperty(notes = "사용자 이름을 입력해주세요.")
	private String name;

	@Past // 과거 날짜만 가능한 제약 조건
	@ApiModelProperty(notes = "사용자의 등록일을 입력해주세요.")
	private Date joinDate;

	@ApiModelProperty(notes = "사용자의 패스워드를 입력해주세요.")
	private String password;

	@ApiModelProperty(notes = "사용자의 주민번호를 입력해주세요.")
	private String ssn; // 주민등록번호
}

 

뭔가 나중에 도움이 될 것 같은 질문

Swagger와 Jackson Filter 사용 시 Swagger-ui의 example value - 인프런 | 질문 & 답변

REST API Monitoring을 위한 Actuator 설정

현재 기동하고 있는 어플리케이션의 상태를 쉽게 monitoring할 수 있다. 현재 서버가 구동 중인지도 확인 가능

서버의 모니터링 도구로 사용 → 별도로 커스터마이징해서 사용하면 더 좋다.

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

에러

org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper';

https://github.com/springfox/springfox/issues/3462

SwaggerConfig.java 안에 bean 설정해주기
@Bean
	public WebMvcEndpointHandlerMapping webEndpointServletHandlerMapping(WebEndpointsSupplier webEndpointsSupplier, ServletEndpointsSupplier servletEndpointsSupplier, ControllerEndpointsSupplier controllerEndpointsSupplier, EndpointMediaTypes endpointMediaTypes, CorsEndpointProperties corsProperties, WebEndpointProperties webEndpointProperties, Environment environment) {
	        List<ExposableEndpoint<?>> allEndpoints = new ArrayList();
	        Collection<ExposableWebEndpoint> webEndpoints = webEndpointsSupplier.getEndpoints();
	        allEndpoints.addAll(webEndpoints);
	        allEndpoints.addAll(servletEndpointsSupplier.getEndpoints());
	        allEndpoints.addAll(controllerEndpointsSupplier.getEndpoints());
	        String basePath = webEndpointProperties.getBasePath();
	        EndpointMapping endpointMapping = new EndpointMapping(basePath);
	        boolean shouldRegisterLinksMapping = this.shouldRegisterLinksMapping(webEndpointProperties, environment, basePath);
	        return new WebMvcEndpointHandlerMapping(endpointMapping, webEndpoints, endpointMediaTypes, corsProperties.toCorsConfiguration(), new EndpointLinksResolver(allEndpoints, basePath), shouldRegisterLinksMapping, null);
	    }

	private boolean shouldRegisterLinksMapping(WebEndpointProperties webEndpointProperties, Environment environment, String basePath) {
	        return webEndpointProperties.getDiscovery().isEnabled() && (StringUtils.hasText(basePath) || ManagementPortType.get(environment).equals(ManagementPortType.DIFFERENT));
	    }

http://localhost:8088/actuator

http://localhost:8088/actuator/health

→ 서버가 작동 중인지 확인할 수 있다

application.yml 설정

조금 더 다양한 파일을 볼 수 있다.

# actuator 설정
management:
  endpoints:
    web:
      exposure:
        include: "*"

HAL Browser

• Hypertext Application Language
• “HAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API”
• API 리소스 사이에서 일관적인 하이퍼링크를 제공
• API 설계에서 HAL을 도입하게 되면 API 간 쉬운 검색이 가능해진다. → 더 나은 개발환경 제공
• HAL을 response message에 도입하게 되면 그 메시지의 포맷과 상관없이 API를 쉽게 사용할 수 있는 정보(메타정보)를 하이퍼링크 형식으로 제공

<dependency>
	<groupId>org.springframework.data</groupId>
	<artifactId>spring-data-rest-hal-browser</artifactId>
</dependency>

HAL Browser가 deprecated 되어서 최신 spring boot 버전에서는 HAL explorer를 통해 사용하면 된다. (버전 추가 안 하면 에러남)

<dependency>
   <groupId>org.springframework.data</groupId>
   <artifactId>spring-data-rest-hal-explorer</artifactId>
	<version>3.5.1</version>
</dependency>

장점

response객체에 부가적인 정보를 제공해준다

링크 정보를 json형태로 표현할 수 있는 표준

장점 : rest자원을 표시하기 위한 자료구조를 만들지 않아도 HATEOAS기능을 사용할 수 있다

Spring Security

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-security</artifactId>
</dependency>

• dependency를 설정한 후, 어플리케이션을 실행하여 비밀번호를 확인해야 한다. (웹서버를 확인하기 위해 필요)
• 5bea3312-3c01-4d40-8ab3-03e86f56627f

• 인증이 되어 있지 않다면 401 Unauthorized가 뜬다.

• 여기에서 username 값을 user로 해도 불러와지는 이유는 spring security의 기본 설정 때문이다.

→ spring.security.user.name / spring.security.user.password를 지정하지 않으면 기본 유저명과 랜덤 패스워드를 사용한다.

→ 기본 유저명은 user이며 password의 경우 스프링부트가 기동될 때 표시된다

• 스프링부트에서 설정할 수 있는 항목

Common Application Properties

Configuration 클래스를 이용한 사용자 인증 처리

[application.yml]
spring:
security:
    user:
      name: nitro
      password: helloworld

추가 : spring cloud bus → yml 파일 변경 시 서버의 재부팅 없이 업데이트 가능

Spring Cloud Bus

@Configuration // Spring boot 기동 시 메모리에 설정 정보를 같이 로딩하게 된다