가이드

‼️ 본 글은 Egene Document 뿐만 아니라 많은 자료를 서칭하여 작성하였습니다. 참고부탁드립니다.

🖇️ REST API

1. API란?

   • Application Programming Interface의 약자이며 클라이언트와 서버의 중간에서 소통의 규칙을 정하면서 효율적으로 정보가 오고 갈 수 있도록 만드는 것 ⇒ Client와 Server 사이의 통신 방식
   • 여러 프로그램들과 데이터베이스, 기능들을 상호 통신 방법을 규정하고 도와주는 매개체 즉, 액세스 권한이 있는 앱의 권한 규정과 서비스 요청에 따라 데이터나 서비스 기능을 제공하는 메신저 역할
   • 예시 사진 첨부
   • 종류 : Public API(구글, 카카오, 공공데이터포털 등 사용), Private API(기업, 연구소 등 사용) 이 중 대중적으로 사용하는 것이 REST/RESTful API와 GraphQL을 가장 많이 사용
   • 행위 : Create, Read, Update, Delete 반드시 적용

2. Rest란?

   • Representation State Transfer의 약자이며 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나

   • 예시로 자원을 하나의 이름(표현)으로 구분하여 해당 자원의 정보(상태)를 주고 받는 모든 것을 의미

     

     https://velog.io/@jiyaho/API-REST-API란 HTTP 프로토콜의 Method(POST, GET, PUT, DELETE)를 활용하여 웹서비스에 CRUD(CREATE, READ, UPDATE, DELETE) 서비스를 요청

3. REST API란?

   • 웹에서 사용되는 여러 리소스들을 URI로 표현하고 그 리소스에 대한 행위를 HTTP Method(GET, POST 등)로 정의하는 방식 Payload를 통해 구조적으로 표현함 ⇒ URI형식(어떤 정보를) * 요청방식(어떻게 할 것인가)

     

     https://medium.com/@MakeComputerScienceGreatAgain/understanding-rest-api-a-comprehensive-guide-52fc10f6c9ed

🖇️ REST 구성요소

이름(표현) : HTTP URI

• 모든 자원에 고유한 이름이 존재하고, 이 자원은 Server에 존재함
• 자원을 구별하는 이름은 **‘/egene/rest/api/entity/:id’**와 같은 HTTP URI임
  • 예시 ⇒ All-in-One 파일 예제
• 관련 파일은 All-in-one의 C:\apps\egene\webapps\itsm\sample\api\restfulapi에서 확인 가능

행위 : HTTP Method

• 자원의 정보(상태)에 대한 행위를 HTTP Method를 통하여 조작
• POST, GET, PUT, DELETE, HEAD와 같은 메서드를 제공
  • POST : 생성 (CREATE)
  • GET : 조회 (READ)
  • PUT : 수정 (UPDATE)
  • DELETE : 삭제 (DELETE)
  • HEAD : header 정보 조회
  • 예시 ⇒ All-in-One 파일 예제

정보 (상태) : HTTP Response