spring boot - api 구조

보통 프런트엔드에서 백엔드에 api를 호출하고 정보를 받아온 다음 그 정보를 화면에 보여줍니다. 그럼 백엔드에서 api를 받고 정보를 넘겨줄 수 있어야 하는데요, 어떤 식으로 진행이 되는지 알아봅시다.

controller

controller는 유저가 유저가 정보를 요청할 때 어떤 경로로 요청해야 하는지, 어떤 식으로 요청해야 하는지가 담겨 있습니다.

파일은 src - main - java - com - example - streak 위치에 계속 만들것입니다. 해당 파일에 package로 health, controller를 만들고 java class로 healthController를 만듭니다.

 

여기에 다음과 같이 만듭니다. @Slf4j부터 만들면 알아서 import 부분이 만들어 집니다.

 

어노테이션(@~~)을 알아봅시다.

 

@Slf4j : 로그를 남기기 위한 것입니다. 하지만 여기서는 쓰지 않았습니다.

@RestController : 뭔가 복잡한 것이 있긴 한데 우선은 데이터를 반환해 주기 위한 것이라 알고 있습시다.

@RequestMapping : 어디로 요청을 해야 하는지에 대한 정보입니다.

@GetMapping : Get으로 정보를 요청한다는 뜻입니다. /open-api/health 뒤에 추가할 경로가 ("")에 들어가지만 지금은 없습니다. post, delete, put도 @PostMapping, @DeleteMapping, @PutMapping으로 호출 가능합니다.

 

즉, {ip}/open-api/health를 get으로 호출하면 이 안에 있는 내용이 실행됩니다. 로컬에서 실행하고 있으니 http://localhost:8080/open-api/health가 됩니다.

 

talent로 호출해 봅시다.

 

body에 잘 나온 것을 알 수 있습니다.