[REST API] Spring Boot Actuator로 API 모니터링하기 & Spring Boot HAL Explorer로 API 탐색하기

Spring Boot Actuator로 API 모니터링하기

Spring Boot Actuator는 운영상황에서 application을 monitor하고 mangage하는 기능을 제공해준다.
Spring Boot Actuator를 사용하려면, Spring Boot Starter Actuator를 add시키면 된다!

pom.xml modified

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

URLS

• Actuator
  • http://localhost:8080/actuator

/src/main/resources/application.properties Modified

by default, Actuator는 어플리케이션의 상태 정보만 보여준다.
그외의 Actuator가 더 많은 정보를 공개하게 하려면, src/main/resources에 application.properties를 다음과 같이 수정해줘야 한다.

management.endpoints.web.exposure.include=*

그리고 나서, 다시 Actuator URL에 들어가면, (http://localhost:8080/actuator) 모든 API 정보가 뜬다.

그 중 beans는 어플리케이션 컨텍스트에 로드된 모든 bean에 대한 정보를 나타낸다.

Spring Boot HAL Explorer로 API 탐색하기

• HAL에 대해 앞서 HATEOAS 살펴볼 때 이미 한번 언급한 적 있다.

  • HAL == format to hyperlink between resources in your API

• HAL Explorer

  • HAL을 이용해, RESTful hypermedia API를 탐색하는, API explorer(탐색기)

• Spring Boot HAL Explorer

  • Spring Boot 프로젝트의 자동설정에 의해 적용된다.

pom.xml modified

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

URLS

• HAL Browser
  • http://localhost:8080
    -> 해당 request url에 맞는 response를 받아, response body에 있는 하이퍼링크를 한번에 보여주는 것!

이렇게, 스프링 프로젝트의 API를 모니터링하고 탐색할 수 있었다!

참고 및 출처

이 시리즈는 Udemy 강의의 내용을 정리한 것입니다.
https://www.udemy.com/course/spring-boot-and-spring-framework-korean/