투케이2K

2. (TWOK/STUDY) [투케이 학습] : REST (Representational State Transfer) API 메소드 종류 학습 본문

투케이2K 학습정리

2. (TWOK/STUDY) [투케이 학습] : REST (Representational State Transfer) API 메소드 종류 학습

투케이2K 2023. 7. 2. 20:44
반응형

[제 목]

[투케이 학습] : REST (Representational State Transfer) API 메소드 종류 학습

 

[내용 정리]

  • REST 설명 :
    • REST 는 Representational State Transfer 라는 용어의 약자로서 http 통신에서 사용하는 아키텍처 입니다
    • HTTP 메소드에서 일반적으로 말하는 CRUD 는 [조회: GET] / [등록: POST] / [수정: PUT] / [삭제: DELETE] 입니다

  • REST 메소드 종류 :
    • GET : 서버로부터 데이터를 취득
    • POST : 서버에 데이터를 추가, 작성 등
    • PUT : 서버의 데이터를 갱신, 수정, 작성 등
    • DELETE : 서버의 데이터를 삭제
    • HEAD : 서버 리소스의 헤더 (메타 데이터 취득)
    • OPTIONS : 리소스가 지원하고 있는 메소드의 취득
    • PATCH : 리소스의 일부분을 수정
    • CONNECT : 프록시 동작의 터널 접속을 변경

  • GET 메소드 설명 :
    • GET 메소드는 주로 데이터를 읽거나(Read) 검색(Retrieve)할 때에 사용되는 메소드 입니다
    • 클라이언트 GET 요청이 성공적으로 이루어진다면 서버는 TEST , JSON 등과 함께 200 (OK) HTTP 응답 코드를 리턴합니다
    • 클라이언트는 GET 방식 요청 시 Body 값을 비우고, Content-Type 은 QueryString 쿼리 파람 형태를 전달하기위해 URL ENCODE 설정을 합니다
    • 로직 : 서버는 GET API 생성 필요 >> 클라이언트가 GET 방식으로 서버에 요청 하면 >> 서버는 DB 조회 >> 조회 결과를 JSON 형태로 포맷 >> 클라이언트로 반환

  • POST 메소드 설명 :
    • POST 메소드는 주로 새로운 리소스를 생성(create)할 때 사용됩니다 (부모 리소스의 하위 리소스)
    • 클라이언트 POST 요청이 성공적으로 이루어진다면 201 (Created) HTTP 응답 코드를 리턴합니다
    • 클라이언트는 POST 방식 요청 시 QueryString 쿼리 파람 / Body Json 데이터를 작성할 수 있습니다 (Content-Type 이 각 방식에 따라 달라짐 / Url Encode / application json)
    • 로직 : 서버는 POST API 생성 필요 >> 클라이언트가 POST 방식으로 서버에 요청 하면 >> 서버는 DB 에 데이터 INSERT 삽입 >> 삽입 성공 및 실패 결과를 >> 클라이언트로 반환

  • PUT 메소드 설명 :
    • PUT 메소드는 리소스를 생성 및 업데이트하기 위해 서버로 데이터를 보내는 데 사용됩니다
    • 클라이언트는 PUT 요청시 Body 에 Json 데이터를 설정 및 Content-Type 에 application json 을 지정해야합니다
    • 로직 : 서버는 PUT API 생성 필요 >> 클라이언트가 PUT 방식으로 서버에 요청 하면 >> 서버는 DB 데이터 UPDATE 수정 >> 수정 성공 및 실패 결과를 >> 클라이언트로 반환

  • DELETE 메소드 설명 :
    • DELETE 메서드는 지정된 리소스를 삭제합니다
    • DELETE 메서드는 데이터를 삭제하는 것이기 때문에 HTTP 요청시에 Body 값과 Content-Type 값이 비워져있으며, URL을 통해서 어떠한 데이터를 삭제할지 파라미터를 받습니다
    • 로직 : 서버는 DELETE API 생성 필요 >> 클라이언트가 DELETE 방식으로 서버에 요청 하면 >> 서버는 DB 데이터 DELETE 삭제 >> 삭제 성공 및 실패 결과를 >> 클라이언트로 반환
 

 

반응형
Comments