인프런 강의 학습/HTTP 기본 지식

HTTP 웹 기본 지식 12일차

현호s 2021. 1. 12. 21:12
반응형

# 모든 개발자를 위한 HTTP 웹 기본 지식 학습

# HTTP API 설계 예시

  • HTTP API - 컬렉션
POST 기반 등록

예) 회원 관리 API 제공
  • HTTP API - 스토어
PUT 기반 등록

예) 정적 컨텐츠 관리, 원격 파일 관리
  • HTML FORM 사용
웹 페이지 회원 관리

GET, POST만 지원

## 회원 관리 시스템 API 설계 - POST 기반 등록

  • 회원 목록 /members > GET
  • 회원 등록 /members > POST
  • 회원 조회 /memebers/{id} > GET
  • 회원 수정 /members/{id} > PATCH, PUT, POST 
PATCH 사용이 가장 좋다.

PUT은 완전히 덮어쓸때 사용(게시판 게시물 수정 등)

POST은 둘다 애매할 경우 사용
  • 회원 삭제 /members/{id} > DELETE

### 회원 관리 시스템 POST - 신규 자원 등록 특징

  • 클라이언트는 등록될 리소스의 URI를 모른다.
회원 등록 /members > POST

POST /members
  • 서버가 새로 등록된 리소스 URI를 생성해준다.
HTTP/1.1 201 Created
Location: /members/100
  • 컬렉션(Collection)
서버가 관리하는 리소스 디렉토리

서버가 리소스의 URI를 생성하고 관리

여기서 컬렉션은 /members

## 파일 관리 시스템 API 설계 - PUT 기반 등록

파일 목록 /files > GET

파일 조회 /files/{filename} > GET

파일 등록 /files/{filename} > PUT

파일 삭제 /files/{filename} > DELETE

파일 대량 등록 /files > POST

### 파일 관리 시스템 PUT - 신규 자원 등록 특징

  • 클라이언트가 리소스 URI를 알고 있어야 한다.
파일 등록 /files/{filename} > PUT

PUT /files/star.jpg
  • 클라이언트가 직접 리소스의 URI를 지정한다.
  • 스토어(Store)
클라이언트가 관리하는 리소스 저장소

클라이언트가 리소스의 URI를 알고 관리

여기서 스토어는 /files

## HTML FORM 사용

  • HTML FORM은 GET, POST만 지원한다.
  • AJAX 같은 기술을 사용해서 해결 가능하다. > 회원 API 참고
  • GET, POST만 지원하므로 제약이 있다.
회원 목록 /members > GET

회원 등록 폼 /members/new > GET

회원 등록 /members/new, /members > POST

회원 조회 /members/{id} > GET

회원 수정 폼 /members/{id}/edit > GET

회원 수정 /members/{id}/edit, /members/{id} > POST

회원 삭제 /members/{id}/delete > POST
  • HTML FORM은 GET, POST 만 지원하므로 제약이 있다. 그래서 이런 제약을 해결하기 위해 컨트롤 URI를 사용
  • 컨트롤 URI
GET, POST만 지원하므로 제약이 있다.

이런 제약을 해결하기 위해 동사로 된 리소스 경로를 사용한다.

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

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

## 정리

  • HTTP API - 컬렉션
POST 기반 등록

서버가 리소스 URI를 결정
  • HTTP API - 스토어
PUT 기반 등록

클라이언트가 리소스 URI를 결정
  • HTML FORM 사용
순서 HTML + HTML form 사용

GET, POST만 지원

## 참고하면 좋은 URI 설계 개념

  • 문서 (document)
단일 개념 (파일 하나, 객체 인스턴스, 데이터베이스 row)
예) /members/100, /files/star.jpg
  • 컬렉션 (collection)
서버가 관리하는 리소스 디렉터리

서버가 리소스의 URI를 생성하고 관리
예) /members
  • 스토어 (store)
클라이언트가 관리하는 지원 저장소

클라이언트가 리소스의 URI를 알고 관리
예) /files
  • 컨트롤러 (controller), 컨트롤 URI
문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행

동사를 직접 사용
예) /members/{id}/delete
 

REST Resource Naming Guide - REST API Tutorial

 

restfulapi.net

 

출처 : 인프런 모든 개발자를 위한 HTTP 웹 기본 지식

반응형
저작자표시 (새창열림)