본문 바로가기

Develop_story/TIL(Today I Learned)

RESTful API

SMALL

1. API란?

  다른 소프트웨어 시스템과 통신하기 위해 따라야 하는 규칙을 정의하는 것으로 개발자는 다른 애플리케이션이 프로그래밍 방식으로 애플리케이션과 통신할 수 있도록 API를 표시하거나 생성한다. 

2. REST란?

  Representational State Transfer의 약자로 API 작동 방식에 대한 조건을 부과하는 소프트웨어 아키텍처이다. REST 기반의 아키텍처를 사용하여 대규모의 고성능 통신을 안정적으로 지원할 수 있다. 

3. RESTful API

  REST 아키텍처 스타일을 따르는 API를 RESTful API라고 부릅니다.

1) 규칙

  1. 슬래시 구분자(/ ) 는계층 관계를 나타내는데 사용합니다.
  2. URI 마지막 문자로 슬래시(/ )를 포함하지 않습니다.
  3. add, edit, delete, find 등의 동사 단어는 사용하지 않습니다.
  4. 불가피하게 URI의 길이가 긴 경우 가독성을 위해 하이픈 ( - )을 사용합니다.
  5. 밑줄 ( _ )은 사용하지 않습니다.
  6. URI는 소문자가 적합합니다.
  7. 파일 ㄱ확장자는 URI에 포함하지 않습니다.
  8. HTTP 메서드를 사용한 인터렉션을 사용 (GET, POST, PUT, PATCH, DELETE)
index Method URI URL   Request Body Description
1 GET /todos /works   "todos": [ { "writer": "작성자", "title": "제목", "desc": "내용", "id": 1 } todos 조회 (불러오기)
2 GET /todos/:id /works/:{id} Detail page   todos 조회 (불러오기)
3 POST /todos /work   "todos": [ { "writer": "작성자", "title": "제목", "desc": "내용", "id": 1 todos 생성
4 DELETE /todos/:id /works   "todos": [ { "writer": "작성자", "title": "제목", "desc": "내용", "id": 1 todos의 id번째를 삭제
5 PUT /todos/:id /works/:{id} Detail page "todos": [ {"desc": "내용"} ] todos의 id번째를 수정

아직 부족하지만 level4 과제를 진행하면서 만들었던 API를 RESTful API로 구현해보았음

LIST

'Develop_story > TIL(Today I Learned)' 카테고리의 다른 글

TypeScript  (0) 2023.03.11
REACT-COOKIE / basic  (0) 2023.03.01
TIL - 68 쿠키, 세션, 쿠키-세션, 토큰  (0) 2023.02.18
TIL - 66 React Query  (0) 2023.02.18
TIL - 65 custom hook  (0) 2023.02.17