본문 바로가기

프로그래밍/Spring Boot

Spring Boot로 REST API 구축 2시간 안에 완성하기


Spring Boot를 이용하여 군더더기 설명 없이, 최소한의 필요한 작업만을 기록하여

따라만 해도 1~2시간 안에 REST API 서버를 빠르게 구축할 수 있습니다.

 

구글링을 통해 여기저기서 정보를 수집하고 여러 블로그를 다니며 정제되지 않은 내용을 찾아 정리하는 수고를 덜고자

전자책으로 정리하였습니다.

 

* 이 글은 <2시간 안에 REST API 핵심 구축하는 방법> 전자책의 일부 내용입니다.

자세한 내용은 다음 링크에서 확인하실 수 있습니다.

 

https://kmong.com/gig/306406

 

REST API 구축 참고서 PDF 드립니다. | 10000원부터 시작 가능한 총 평점 0점의 취업·투잡, 전자책·노

3개 총 작업 개수 완료한 총 평점 0점인 블로비니의 취업·투잡, 전자책·노하우, 직무 스킬업 서비스를 0개의 리뷰와 함께 확인해 보세요. 취업·투잡, 전자책·노하우, 직무 스킬업 제공 등 10000원

kmong.com


🔨 REST API 서버 개발 환경구축 🔨

1. Spring Tools For Eclipse 다운로드(IDE 필요 시)

 

Spring Tools 4 is the next generation of Spring tooling

Largely rebuilt from scratch, Spring Tools 4 provides world-class support for developing Spring-based enterprise applications, whether you prefer Eclipse, Visual Studio Code, or Theia IDE.

spring.io

OS버전에 맞는 툴을 다운로드하면 jar 파일이 받아진다.

길게 생각할 것 없이 압축을 풀고 content.zip이라는 압축파일이 또 나오는데 그것도 풀면

비로소 sts 툴 폴더가 해제된다. 이를 적당한 작업 위치에 복사하여 이용한다.

 

 

2. 스프링 프로젝트 다운로드

https://start.spring.io/

Spring Initializr를 이용하여

작업의 토대가 될 프로젝트를 다운로드 한다.

위 링크로 이동하여 다음 그림과 같이 설정하여 GENERATE를 클릭한다.

대부분 디폴트대로 설정하고(프로젝트 Name, Description 등은 기호에 따라 설계에 따라 변경하기!) ,

Java를 8

Dependencies에 지금은 Web 하나만을 추가한다. (나중에 pom.xml을 통해 언제든 다른 것들도 추가 가능)

다운로드가 완료되면 설정한 작업 공간에 압축을 푼다.

 

 

3. GENERATE로 받은 프로젝트 Import

0번 순서에서 다운로드한 STS툴을 열고 (혹은 보유중인 IDE를 열고)

방금 전에 다운로드 받은 프로젝트를 Import 한다.

(1) Import projects... 클릭

 

(2) Existing Maven Project를 선택하여 Next 클릭

 

(3) Spring Initializr로 받은 프로젝트를 Import하면 pom.xml이 체크 활성화 되니 확인하고 Finish

그림처럼 Import 작업 후 Finish 버튼까지 눌렀으면 툴에서 Maven 라이브러리를 등록하는 등등 설정을 수행하고

그것이 끝나면 사실상 구축 자체는 끝이다.

이제 Spring 앱을 실행하여 이상없는지 확인을 한다.

 

4. Spring App 서버로 실행하기

실행방법은 여러가지가 있을 수 있으나, 이 포스팅 컨셉에 맞게 쉽게 가도록 한다.

그저 실행 버튼을 눌러 확인하면 된다.

Boot Dashboard 내용의 local -> demo 프로젝트를 선택한 상태에서 실행 버튼을 클릭한다.

 

위와 같이 Started XXXXX in 0.000 seconds ~ 라는 마지막 consol 메시지가 뜨면 성공적으로 실행 된 것이다.

 

Console 창에도 보이듯, 기본적으로 8080 포트를 사용하여 Spring 앱을 기동한다.

(Spring Boot 실행 포트 변경에 관하여 환경설정에 관한 포스팅에 따로 등록할 예정!)

http://localhost:8080 <- 이 주소를 입력하보면 아래 그림과 같이 에러 페이지가 뜰 것이다.

이는 보여줄 페이지가 없기 때문에 Spring 앱 자체에서 보여주는 에러 페이지이며,

현재 상적으로 Spring Boot 프로젝트를 구축했다는 의미이기 때문에

에러 페이지라 하여도 신경쓰지 않아도 문제 없다.

 

시작이 반이다. 😄

사실상 이로서 Spring Boot를 이용한 서버 구축은 자체는 끝났고

이제 CRUD 기능을 하나씩 추가하여 Rest API스럽게 다듬어 가야한다.