Spring - API 생성하기

API
: 클라이언트 - 서버간의 약속

• 클라이언트가 정한대로 서버에서 요청(Request)을 보내면, 서버가 요구사항을 처리하여 응답(Response)을 반환한다.

API를 설정하는 기본적인 네가지 기준
1. Rest
: 주소의 명사, 요청 방식에 동사를 사용함으로써 의도를 명확히 드러냄을 의미한다.

• 여기서 동사는 우리가 JPA 시간에 배운 CRUD를 지칭한다.
  • 예를들어, course에 대해 생성을 요청하면 POST라는 동사를 쓰고 조회를 하면 GET, 수정은 PUT, 삭제는 DELETE 라는 동사를 쓴다.

    예시

    • GET/courses
      GET이라는 동사로, courses라는 명사를 요청하고 있다.
      -> 강의 목록 전체 게시물을 조회 요청하는 것
    • GET/courses/1
      /숫자 가 있다면 보통 이 숫자는 ID를 의미한다.
      ->courses에서 ID가 1번인 녀석을 조회 요청
    • POST/courses
      ->couses에 대해서 새로운 신규 강의 개설을 요청
    • PUT/courses/3
      -> ID가 3번인 courses에 대해서 수정 요청
    • DELETE/courses/2
      -> ID가 2번인 녀석에 대해서 삭제 요청

API 만들 때 주의사항

• 주소에 들어가는 명사들은 복수형을 사용한다
  • /courses
• 주소에 동사는 가급적 사용하지 않는다.
  • /accounts/edit
    이 경우 edit은 PUT으로 대체할 수 있다.