#6 API, REST API, EndPoint

API

고객이 점원에게 음식을 주문하면 점원은 주문을 주방에 전달하고, 주방에서는 음식을 만들어 점원에게 전달하고, 점원은 손님에게 음식을 서빙한다.

API는 점원처럼 프로그램 혹은 시스템 간의 통신하는 창구, 즉
프로그램들이 서로 상호작용하는 것을 도와주는 매개체라 할 수 있다.

REST API

REST API란 REST를 기반으로 만들어진 API다.

REST란?
REST(Representational State Transfer)의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미한다.

• Http URI를 통해 자원을 명시
• Http Method를 통해 해당 자원에 대한 CRUD Operation를 적용하는 것.

C : create (POST)
R : read (GET)
U : update (PUT, PATCH)
D : delete(DELETE)

EndPoint

ENDPOINT는 API가 서버에서 리소스에 접근할 수 있도록 가능하게 하는 URI이다.

EndPoint작성요령

1. 명사를 기반으로 작성.
   /tests, /users, /posts, /boards
   /test, /user, /post, /board

2. 자원에 대한 행위는 HTTP method로 표현한다.
   게시물 조회
   GET /posts/show/1 → /posts/1

게시물 추가
POST /posts/insert/1 → /posts/1

3. /는 계층 관계를 나타내는데 사용.
   /posts/:postid/comments

4. URI마지막에 /를 포함하지않는다.

5. _ 보다는 -으로 가독성을 높인다.

6. 소문자로 작성

이정도만 알고있으면 대충 작성할때 참고할 수 있을것같다.

참고블로그 : https://blog.naver.com/ghdalswl77/222401162545
https://velog.io/@itissteam/restful-api-endpoints-well-written-guide#%EF%B8%8F-%EC%9A%A9%EC%96%B4-%EC%A0%95%EB%A6%AC