minlog

World wide web , www, w3 

인터넷에 연결된 컴퓨터를 통해 사람들이 정보를 공유할 수 있는 전 세계적인 정보 공간

 

💡 Web Site

google, naver, daum 등 HTML로 구성된 여러 사이트들

 

💡 API (Application Programming Interface)

Kakao open API,Google open API  등

 

💡 User Interface

Chrome,Safari,Explorer,Smart Watch 등

 

 

 

Web구성 3가지

1. URI (Uniform Resource Identifier)

리소스 식별자

특정 사이트, 쇼핑목록, 동영상 목록 등

모든 정보에 접근 할 수 있는 정보

 

2. HTTP (Hypertext Transfer Protocol)

어플리케이션 컨트롤할때 사용. (어떤 프로토콜로 받을 것인가에 따라 다름)

GET / POST / PUT / DELETE / OPTIONS / HEAD /TRACE /CONNECT

 

3. HTML (Hyper Text Markup Language)

하이퍼미디어 포멧

XML을 바탕으로한 범용 문서 포멧

이를 이용하여 User Interface로 사용자가 알아보기 쉬운 형태로 표현

 

 

 

REST API

REST (Representational State Transfer)

자원의 상태 전달 - 네트워크 아키텍처

 

1. Clint, Server

클라이언트와 서버가 서로 돌립적으로 분리 되어 있어야한다.

 

2. Stateless 

요청에 대해서 클라이언트의 상태를 서버에 저장하지 않는다.

 

3. Cache 

클라이언트는 서버의 응답을 임시저장 할 수 있어야한다.

클라이언트가 캐시를 사용해 응답을 재사용할 수 있고 서버의 부하를 낮춘다.

 

4. 계층화 

서버와 클라이언트 사이에 방화벽,게이트웨이,Proxy 등 다양한 계층 형태로 구성이 가능해야하며 이를 확장 할 수 있어야 한다.

 

5. 인터페이스 일관성

인터페이스의 일관성을 지키고 , 아키텍처를 단순화 시켜 작은 단위로 분리. 클라이언트, 서버가 돌립적으로 개선 될 수 있어야한다.

 

6. Code on Demand(Optional)

자바 애플릿, 자바 스크립트, 플래시 등 특정한 기능을 서버로 부터 클라이언트가 전달 받아 코드를 실행시킬 수 있어야한다.

 

 

💡 REST를 잘 사용했는지 판단 기준

1. 자원의 식별

웹기반 REST에서는 리소스 접근할때 URI를 사용한다.

https :// ji.co.kr / user (리소스) /100 (식별자)

Resource : user, 식별자 : 100 =  100번째 유저 

 

 

2. 메시지를 통한 리소스 조작

웹에서는 다양한 방식으로 데이터를 전달 가능하다 . *HTML,XML,JSON,TEXT 등

이중 어떤 타입의 데이터인지 알려주기 위해서 HTTP Header부분에 content-type을 통해 데이터 타입을 지정해 줄 수 있다.

그리고 리소스 조작을 위해서 데이터 전체를 전달 하지 않고, 이를 메시지로 전달한다.

 

ex)  서버의 user 라는 정보의 전화번호를 처음 number라고 정의.

이 정보를 클라이언트와 주고 받을때 그대로 number라고 사용했다면,

이후 서버에서 resource 변경으로 phone-number라고 바꿀시 클라이언트는 내용을 확인하지 못하고 에러가 난다.

이러한 부분을 방지 하기 위해 별도의 메시지 형태로 데이터를 주고 받으며, client-server가 독립적으로 확장이 가능하다.

 

 

3. 자기 서술적 메시지

요청하는 데이터가 어떻게 처리되어야 하는지 충분한 데이터를 포함해야한다.

HTTP기반의 REST에서는 HTTP Method와 Header정보, URI가 포함되는 정보로 표현해야한다.

그외에 담지 못한 정보들을 URI 의 메시지를 통해 표현한다.

요청 URI 처리 내용
GET https://ji.co.kr/user/100 사용자의 정보 요청
POST https://ji.co.kr/user 사용자 정보 생성
PUT https://ji.co.kr/user 사용자 정보 생성 및 수정
DELETE https://ji.co.kr/user/100 사용자 정보 삭제

 

 

4. 애플리케이션 상태에 대한 엔진으로써 하이퍼미디어

단순히 한가지 클라이언트 요청에 대한 데이터만 응답하는 것이 아니라 리소스에 대한 Link정보까지 포함되어져야한다.

 

 

 

 

💡 URI 설계 패턴

1. URI(Uniform Resource Identifier)

인터넷에서 특정 자원을 나타내는 주소값. 해당 값은 유일하다.(응답은 달라질 수 있다.)

 

요청 :  https:// www.ji.co.kr / resource / sample 

응답 : ji.pdf ,ji.docx 등...

 

2. URL (Uniform Resource Locator)

인터넷 상에서 자원, 특정 파일의 위치를 식별하는 주소

요청 :  https:// www.ji.co.kr / ji.pdf

 

 

 

 

💡 URI 설계 원칙 (RFC -3986)

https:// ji .co.kr / class / java / curriculums / web-master

 

-  슬래시 구분자 ( / )는 계층 관계를 나타낸다.

 

-  URI 마지막 문자로 ( / )는 포함되지 않는다.

 

-  하이픈( - )은 URI 가독성을 높이는데 사용한다.

 

-  밑줄( _ )은 사용하지 않는다.

 

-  URI경로에는 소문자가 적합하다.

https:// ji .co.kr / class / JAVA / curriculums / web-master (x)

https:// ji .co.kr / class / java / curriculums / web-master (o)

 

-  파일 확장자는 URI에 포함하지 않는다.

https:// ji .co.kr / class / java / curriculums / web-master.jsp

 

-  프로그래밍 언어에 의존적인 확장자를 사용하지 않는다.

https:// ji .co.kr / class / java / curriculums / web-master.do

 

-  구현에 의존적인 경로를 사용하지 않는다.

https:// ji .co.kr / servlet / class / java / curriculums / web-master.jsp

 

-  세션 ID를 포함하지 않는다.

https:// ji .co.kr / servlet / class / java / curriculums / web-master.jsp?session-id=abcd

 

- 프로그래밍 언어의 Method명을 이용하지 않는다.

https:// ji .co.kr / servlet / class / java / curriculums / web-master.jsp?action=intro

 

- 명사에는 단수형 보다는 복수형을 사용 

https:// ji .co.kr / servlet / classes / java / curriculums / web-master.jsp?action=intro

 

- 컨트롤러 이름으로는 동사나 동사구를 사용

 

- 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.

https:// ji .co.kr / servlet / classes / java / curriculums / web-master/{lesson-id}/users/{user-id}

https:// ji .co.kr / servlet / classes / java / curriculums / web-master/2/users/100

 

- CRUD기능을 나타내는 것은 URI에 사용하지 않는다.

GET : https:// ji .co.kr / servlet / classes / java / curriculums / web-master/lessons/2/users/100/READ (X)

DELETE : https:// ji .co.kr / servlet / classes / java / curriculums / web-master/lessons/2/users/100

 

- URI Query Parameter 디자인

 

- URI쿼리 부분으로 컬렉션과 결과에 대해서 필터링 할 수 있다.

https:// ji .co.kr / servlet / classes / java / curriculums / web-master?chapter=2

 

- URI 쿼리는 컬렉션의 결과를 페이지로 구분하여 나타내는데 사용한다.

https:// ji .co.kr / servlet / classes / java / curriculums / web-master?chapter=2&page=0&size=10&sort=asc

 

- API에 있어서 서브 도메인은 일관성 있게 사용해야한다.

https:// api.ji .co.kr

https:// api-ji .co.kr

 

- 클라이언트 개발자 포탈 서브 도메인은 일관성 있게 만든다. (개발환경 , 사용자 운영환경에 올리기 전에 테스트 환경)

https:// dev-ji .co.kr

https:// developer-ji .co.kr

 

 

 

profile

minlog

@jimin-log

포스팅이 좋았다면 "좋아요❤️" 또는 "구독👍🏻" 해주세요!