REST API
REST API는 웹에서 사용되는 데이터나 리소스를 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말한다.
REST API를 작성할 때 지켜야 할 규칙
위 그림처럼 3단계까지 있지만 실제로 엄밀하게 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우 HTTP API 라고도 부른다.
- 0단계 HTTP 사용 : 단순히 HTTP 프로토콜을 사용하는 것
- 1단계 개별 리소스와의 통신 준수 : 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 한다는 것과 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다는 것
더불어 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.
- 2단계 HTTP 메소드 원칙 준수 : CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것
Postman
HTTP API 테스트 도구 중 하나로써 도구들 중 가장 사용하기 쉽다.
GET 요청하기
GET URL/minseong3/messages
GET 출력 예시
{
"id": 1,
"username": "minseong3",
"text": "안녕하세요",
"roomname": "로비",
"date": "2021-04-02 12:00:00"
}POST 요청하기
POST URL/minseong3/messages
JSON 형식으로 보낼 때에는, raw를 선택한다.
보낼 형식에 맞게 정확한 타입을 선택한다. (JSON 선택)
선택한 형식에 맞게 본문을 입력한다.
POST 출력 예시
{
"id": 0
}