Restful API 서버 만들기

스프링 부트의 경우 스프링과 비교하여 아주 심플하게 API서버를 구축해볼 수 있다.

 

다만 아래와 같은 조건에 따라 프로젝트의 양이나 복잡도가 달라진다.

 

 

 
1. 원천 데이터의 형태 : RDBMS, NoSQL, Hadoop 등
    : 어떠한 곳에서 원천 데이터 정보를 가져와서 클라이언트에 보내줄지 정해야 한다.

2. 캐시 데이터 사용 여부
    : 클라이언트의 정보 요청을 받을때마다 계속 원천데이터를 새롭게 읽어들일 것인지, 그렇게 계속 Read하여 실시간으로 최신정보를 리턴할 필요가 없는지 ( 예를들어 1시간 주기로만 갱신정보를 리턴해도 된다든가 하는 )를 정해야 한다.

3. HTTP 메소드 방식 : restful인가 아닌가
    : API주소를 조금 더 명확하고 정형화하여 처리하는게 목적을 둔 restful api방식을 최근에는 선호한다.

4. 접근 제어 : 보안처리 및 사용자 제어
    : 익명의 사용자도 접근이 가능하게 할 것인가 아닌가에 따라 보안 정책 및 사용자 구분 처리를 해야한다.

 

 

프로젝트 생성

인텔리제이를 실행하여 'Create New Project' - 왼쪽에서 'Maven' 선택후 'Name'작성 후 Next

 

 

 

 

 

프로젝트 기본 구성확인 및 수정

프로젝트 생성 후 바로 보이는 pom.xml을 다음과 같이 수정 (parent, dependencies, build)하여 스프링 부트 의존성 추가

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.sentilab</groupId>
    <artifactId>sentilabHadoop</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.7.RELEASE</version>
    </parent>

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

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

 

이후 오른쪽 상단에 보이는 refresh 클릭하여 적용

 

 

< 다음과 같이 프로젝트 구조 생성 >

1) src-main-java 에서 package 생성 

2) 생성한 package 내에 startApp , ApiController : JAVA CLASS 생성

 

 

 

 

startApp Class 수정 : SpringBoot 향으로 변경

package com.restapi;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class starApp {

    public static void main(String[] args) {
        // SpringApplication을 실행하겠다.
        SpringApplication.run(starApp.class, args);
    }
}

• 핵심
  • @SpringBootApplication 어노테이션 추가
  • main 클래스에 SpringApplication.run 추가

 

 

 

💡 실행 타겟 만들기

 

1. 상단 'Add Configuration' 클릭

 

2. 팝업 좌측 +버튼 클릭하여 SpringBoot 선택 ( 인텔리제이 커뮤니티 버전에서는 스프링부트 보이지 않음 )

 

3. 상단 Name 변경 후, 중앙 Build and run 탭의 

사진상에 com.restapi.startApp 칸의 맨 오른쪽 $ 선택하여 사진처럼 startApp 선택

 

 

 

4. 빌드를 실행하여 결과 확인

 

 

 

💡 Rest Api 적용

1. 생성했던 ApiController 클래스에 다음과 같이 기본적인 API호출 리턴 클래스를 생성하고 앱 재시작

package com.restapi;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ApiController {

    @RequestMapping(value="/api/test",method = RequestMethod.GET)
    @ResponseStatus(value= HttpStatus.OK)
    public String getApiTest(){
        return "{\"result\":\"test\"}"; // json type 반환
    // /api/test 주소를 호출하면 -> return에 있는 값을 돌려주겠다.
    }
    // localhost:8080/api/test
}

 

 

2. localhost:8080/api/test 접속하여 정상적으로 결과 반환해주는 확인