[CS] RESTful API 를 작성하기 위하여 고려할 것

✏️REST API

REST는 Representational State Transfer라는 용어의 약자로 웹의 장점을 최대한 활용할 수 있는 아키텍처이다. 

---

REST 구성

• 자원 - URI
• 행위 - HTTP METHOD
• 표현

---

REST의 특징

1. Uniform(인터페이스)
   URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일
2. Stateless(무상태)
   작업을 위한 상태정보를 따로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다. 
   서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.
3. Cacheable(캐시 가능)
   HTTP라는 기존 웹표준을 그대로 사용하기 때문에 웹에서 사용하는 기존 인프라를 그대로 활용이 가능하다. 
4. Self-descriptiveness(자체 표현 구조)
   REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어있다.
5. Client-Server 구조
   REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트 등을 직접 관리하는 구조로 각각의 역할이 확실하게 구분되어 개발해야 할 내용이 명확해지고 서로 간의 의존성이 줄어들게 된다.
6. 계층형 구조
   REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 프록시, 게이트웨이 같은 네트워크 기방의 중간매체를 사용할 수 있게 한다. 

---

REST API 디자인 가이드

1. URI는 정보의 자원을 표현해야 한다.
2. 자원에 대한 행위는 HTTP Method로 표현한다.

 

1) URI는 정보의 자원을 표현해야 한다.(리소스명은 동사보다는 명사를 사용한다.)

@GetMapping("/post/get/{postId}")

 

GET 메서드를 사용하는데 URI에 또 한 번 /get과 같은 행위에 대한 표현이 들어가서는 안된다.

 

+get과 같은 경우에는 시큐리티에서 인증된 정보가 없더라도(비회원도) 접근할 수 있어야 하는데 

.requestMatchers("/post/**").permitAll()

 

이런 식으로 /post의 하위 계층까지 모두 포함시켜서 허용을 해줘 버리면 인증 정보가 필요한 다른 API에서는 충돌이 일어나게 된다. 그래서 REST 하지 않게  "/post/get/**"을 썼었다. 그런데 이 부분은 

.requestMatchers(HttpMethod.GET,"/post/**").permitAll()

이렇게 써줌으로써 해결할 수 있었다. GET으로 들어온 요청만 허용해 주는 것이다.

 

 

2) 자원에 대한 행위는 HTTP Method로 표현한다.

• HTTP Method의 알맞은 역할

Method	역할
POST	리소스 생성
GET	리소르 조회. 리소스를 조회하고 해당 토큐먼트에 대한 자세한 정보를 가져온다.
PUT	리소스 수정
DELETE	리소스 삭제

 

+이전에 Param 형식으로 입력값을 받으며 POST Method를 써야 하는데 급하게 GET Method를 써서 기능을 구현한 적이 있다. 어떤 기능이었는지는 가물가물한데 그때는 REST API에 대한 개념이 없어서 그래도 되는 줄 알았다. 나중에 이게 문제가 될 수도 있다 하여 RequestDto를 만들어 입력값을 RequestBody 형태로 받도록 수정하여 POST Method를 적용하였다.

---

URI 설계 시 주의할 점

1) 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용한다.

http://localhost:8080/user/rating

 

2) URI 마지막 문자로 슬래시(/)를 포함하지 않는다.

• REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시를 사용하지 않는다.

3) 하이픈(-)은 URI 가독성을 높이는 데 사용한다.

 

4) 밑줄(_)은 URI에 사용하지 않는다.

• 밑줄은 보기 어렵거나 밑줄 문자가 가려지기도 하기 때문에 가독성을 위해 하이픈을 사용하는 것이 좋다.

5) URI 경로에는 소문자가 적합하다.

• 대문자 사용은 피하도록 하는 게 좋다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문이다.

+ URI를 설계할 때 가독성을 위해서 카멜 케이스 형태로 넣어도 되나 고민했던 적이 있다. 막연하게 그동안 URI는 모두 소문자로 작성하였고 형식에 맞지 않을 수도 있다는 생각에 다른 단어로 대체하였었는데 앞으로는 하이픈을 이용하도록 해야겠다.

 

6) 파일 확장자는 URI에 포함시키지 않는다.

• 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI에 포함시키지 않고 Accept header를 사용한다.

    http://restapi.example.com/members/soccer/345/photo.jpg (X)

---

자원을 표현하는 Colllection과 Document

@RequestMapping("/user")
public class UserController {

    private final UserService userService;
    private final UserS3Service userS3Service;

    @GetMapping("")

    }

    @PutMapping("/nickname")
    
    }

    @PostMapping("/password")

    }


    @PutMapping("/password")
    
    }


    @PutMapping("/image")

    }
}

 

User라는 컬렉션 안에 여러 도큐먼트로 표현하고 있다.

http://localhost:8080/user/password
http://localhost:8080/user/nickname
http://localhost:8080/user/image

 

여기서 컬렉션은 복수로 사용하고 있다는 점이 중요하다. 좀 더 직관적인 REST API를 위해서 컬렉션과 토큐먼트를 사용할 때 단수 복수도 지켜준다면 좀 더 이해하기 쉬운 URI를 설계할 수 있다.

---

HTTP 응답 상태 코드

• Rest API는 URI만 잘 설계된 것이 아닌 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 한다.
  정확한 응답의 상태코드만으로도 많은 정보를 전달할 수 있기 때문에 적절한 상태코드 값을 돌려주는 것은 중요하다.

throw new CustomException(ErrorMessage.DUPLICATE_NICKNAME_EXISTS, HttpStatus.CONFLICT);
throw new CustomException(ErrorMessage.FAILED_TO_SEND_EMAIL, HttpStatus.INTERNAL_SERVER_ERROR);
throw new  CustomException(ErrorMessage.INVALID_INPUT, HttpStatus.BAD_REQUEST);
throw new CustomException(ErrorMessage.FAILED_TO_SEND_EMAIL, HttpStatus.INTERNAL_SERVER_ERROR);

 

나는 이 중요성을 알고 클라이언트에 적절한 상태코드와 함께 메시지까지 함께 보내주어 정보를 읽고 대비하는데 더욱 쉽게 하였다.