글제목, 내용 정도만 있는 간단한 게시판 API를 만들어 보려고 한다.
스프링을 만진지 어언 1년이 다 되어 스프링이 하나도 기억나지 않아 복습 차원에서 열심히 스터디 중이다! 😂
일단 가장 먼저 Rest API란 무엇일까?
Rest API란 URL의 설계 방식을 의미한다.
주소와 메서드만 보고 요청의 내용을 파악할 수 있다는 강력한 장점이 있어 많은 개발자들이 사용한다고 한다.
그러면 Rest API는 어떻게 사용할까?
1. URL에는 동사를 쓰지 말고, 자원을 표시해야 한다.
예를 들어서 게시판의 내용을 리턴해주는 API를 만든다고 해보자.
/getBoard?Id=1
/board?id=1
물론, 둘 다 사용해도 되지만, 어떤 개발자는 getBoard가 아닌 showBoard와 같이 사용한다면 API는 엉망이 될 것이다. 그래서 Restful API를 설계할 때는 이런 동사를 사용하지 않는다.
2. 동사는 HTTP 메서드로
HTTP 메서드란 서버에 요청하는 방법을 나눈 것이다. 주로 사용하는 것들로는 GET, POST, PUT, DELETE 방식이 있다. 각각 POST-CREATE, GET-READ, PUT-UPDATE, DELETE-DELETE의 역할을 하는데 이것을 CRUD 라고 부른다.
특정 게시글을 가져오려면
GET /board/1
특정 게시글을 생성하려면
POST /board/1
특정 게시글을 수정하려면
PUT /board/1
특정 게시글을 삭제하려면
DELETE /board/1
과 같이 사용하면 된다.
위 규칙들을 지켜가며 게시판 API를 앞으로 개발해 나가 보겠다.
영차영차