Rest API?

Spring Boot - What is Rest API?

💡 Rest란?

​

• 웹과 같은 분산 하이퍼미디어 시스템에서 사용하는 통신 네트워크 아키텍처
• HTTP와 URI의 단순하고 간결한 장점을 계승한 Network 아키텍쳐
• 참고 : 

https://meetup.toast.com/posts/92

 

💡 Rest가 만들어진 목적

• 구성요소 상호작용의 규모 확장성
• 인터페이스의 범용성
• 구성요소의 독립적인 배포
• 중간적 구성요소를 이용한 응답 지연 감소, 보안 강화, 레거시 시스템 인캡슐레이션

Rest API 설계하기

• 자원 : URI
• 행위 : HTTP 메소드
• 표현 : 리소스에 대한 표현 (HTTP Message Body)

💡 URI 설계

URI는 URL을 포함한 개념

URL : 웹상의 파일 위치를 표현 -> http://localahost8080/api/book.pdf

URI : 웹에 있는 자원의 이름과 위치를 식별 -> http://localhost:8080/api/book/1

• URI 는 명사를 사용하며 동사를 피해주자. 동사를 쓰지 않고 HTTP 메소드로 대체를 해줘야한다.

• 복수형을 사용하자.

• 컬렉션으로 URI를 사용할 경우 컬렉션을 한번 더 감싼 중첩형식으로 사용하자 -> 추후 수정, 확장 시 번거로움을 없앰

__중첩 전 __

{
    { 
        books: ...
    },
    {
        stores: ...
    }

}

중첩 후

{
    _embedded: [
        {
            books:...
        },
        {
            stores:...
        },
    ]
}

💡 행위설계

• books를 갖고 행위를 설계한다고 하자

• book 목록을 보기 위해서는 GET(read)를 사용해야하며, book을 추가하기 위해서는 POST(create)를 사용해야한다.

• 이렇게 GET, POST, PUT, DELETE를 알맞게 기능에 맞춰 만들어줘야 한다.

(예시) books를 게시판에 표현할 때 페이징을 처리하는 값을 추가해주자

JPA의 pageable의 프로퍼티값을 그대로 사용할 수 있다.

GET http://localhost:8080/api/books?page=0&size=10&sort=desc