대충이라도 하자

API 설계 본문

꼬꼬마 개발자 노트

API 설계

Sueeeeee
반응형

Method

-PATCH : 부분 수정 ***PATCH를 쓰는 것이 좋음

-PUT : 기존에 있던 것을 덮어버림 ***덮어버리기에, 전체 정보가 누락 없이 보내야 함

-POST *** 2개 다 애매할 경우, 천하무적 POST 사용

 

 

파일관리시스템- 신규 자원 등록

: 등록은 POST, PUT  2가지 경우 있음

1. POST로 등록하는 것은 클라이언트가 서버에 요청 - 등록해달라고 그래서 서버가 만들어줌

->컬렉션(Collections) : 서버가 리소스 URI 결정

2.하지만, PUT은 클라이언트가 리소스 URI를 알고 있어야 한다.

-> 스토어(Store)

***대부분 POST 기반의 컬렉션 사용

 

 

API Vs HTML FORM

: html form은 get, post만 사용 가능 -> AJAX 같은 기술 사용해서 해결 가능

컨트롤 URI

- get, post만 사용하므로 제약

- 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용

- POST 의 /new, /edit, /delete가 컨트롤 URI

- HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 사용)

 

 

 

참고하면 좋은 URI 설계 개념

- document

- Collection : 대부분 컬렉션 사용

- Store : 가끔, 파일을 위해 사용할 수 있음...?

- Controller, Control URI 

: 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행

 동사를 직접 사용

 ex) /member/{id}/delete

 

반응형

'꼬꼬마 개발자 노트' 카테고리의 다른 글

Docker  (0) 2022.08.12
멱등(Idempotent)  (0) 2022.04.24
Stateless & Connectionless  (0) 2022.01.27
Elasticsearch 설치 및 사용 (Windows)  (0) 2022.01.18
XML파일  (0) 2022.01.06
Comments