1. REST란? Representational State Transfer의 약자로 자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고받는 모든 것 즉, 자원(resource)의 표현(representation) 에 의한 상태 전달을 의미한다.
이미지 출처 : https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html
* 자원(resource)의 표현(representation) - 자원: 해당 소프트웨어가 관리하는 모든 것 예) 문서, 그림, 데이터, 해당 소프트웨어 자체 등 - 자원의 표현: 그 자원을 표현하기 위한 이름 예) DB의 학생 정보가 자원일 때, ‘students’를 자원의 표현으로 정한다. * 상태(정보) 전달 - 데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달한다. JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.
www와 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식으로 REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다. REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다.
REST가 필요한 이유는 1) ‘애플리케이션 분리 및 통합’ 2) ‘다양한 클라이언트의 등장’ 3) 최근의 서버 프로그램은 다양한 브라우저와 안드로이폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 한다. 이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 되었다.
2. REST 개념 HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE, PATCH 등)를 통해 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미한다. 즉, REST는 자원 기반의 구조(ROA, Resource Oriented Architecture)로 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미한다. 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.
* CRUD Operation 이란?
CRUD는 대부분의 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리 기능인 Create(생성), Read(읽기), Update(갱신), Delete(삭제)를 묶어서 일컫는 말이다. REST에서의 CRUD Operation 동작 예시는 다음과 같다. . Create : 데이터 생성(POST) . Read : 데이터 조회(GET) . Update : 데이터 수정(PUT, PATCH) . Delete : 데이터 삭제(DELETE)
3. REST 구성 요소 및 특징
1) REST는 다음과 같은 3가지로 구성이 되어있다.
- 자원(Resource) : HTTP URI . 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다. .자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 이다. .Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다. -자원에 대한 행위(Verb) : HTTP Method
. HTTP 프로토콜의 Method를 사용한다. . HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다. -자원에 대한 행위의 내용 (Representations) : HTTP Message Pay Load
. Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다. . REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다. . JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.
2) REST의 특징 - Server-Client(서버-클라이언트 구조)
. REST Server (자원이 있는 쪽) : API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다. . Client (자원을 요청하는 쪽) : 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다. . 서로 간 의존성이 줄어든다. - Stateless(무상태)
. HTTP 프로토콜은 Stateless Protocol 임으로 REST 역시 무상태성을 갖는다. . Client의 context를 Server에 저장하지 않는다. 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 됨으로 구현이 단순해진다. . Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다. → 각 API 서버는 Client의 요청만을 단순 처리한다. 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다. 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용하며, Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다. - Cacheable(캐시 처리 가능)
. 웹 표준 HTTP 프로토콜을 그대로 사용함으로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다. 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다. . 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다. . 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다. - Layered System(계층화)
. Client는 REST API Server만 호출한다. . REST Server는 다중 계층으로 구성될 수 있다. →API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다. 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다. . PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다. - Uniform Interface(인터페이스 일관성)
. URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다. . HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다. 특정 언어나 기술에 종속되지 않는다.
- Code-On-Demand(optional) . Server로부터 스크립트를 받아서 Client에서 실행한다. . 반드시 충족할 필요는 없다.
4. REST의 장단점
1)장점 - HTTP 프로토콜의 인프라를 그대로 사용함으로 REST API 사용을 위한 별도의 인프라를 구축 할 필요가 없다. - HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해 준다. - HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다. - Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다. - REST API 메시지가 의도하는 바를 명확하게 나타냄으로 의도하는 바를 쉽게 파악할 수 있다. - 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다. - 서버와 클라이언트의 역할을 명확하게 분리한다. 2)단점 - 표준이 자체가 존재하지 않아 정의가 필요하다. - HTTP Method 형태가 제한적이다.(사용 할 수 잇는 Method가 4가지 밖에 없다) - 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야
함으로 전문성이 요구된다. - 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다.(익스폴로어) →PUT, DELETE를 사용하지 못하고, pushState를 지원하지 않는 점
4. REST API란? RESPT API란 REST의 원리를 따르는 API를 의미한다.
최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공한다.
*API(Application Programming Interface)란 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것이다.
5. REST API 특징 및 설계 규칙
1) REST API 특징 - 사내 시스템들도 REST기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다. - REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다. 즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.
2) REST API 설계 규칙
REST API를 올바르게 설계하기 위해서는 지켜야 하는 몇가지 규칙이 있다. * 리소스 원형
- 도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념 - 컬렉션 : 서버에서 관리하는 디렉터리라는 리소스 - 스토어 : 클라이언트에서 관리하는 리소스 저장소
*URI는 정보의 자원(resource)을 표현해야 한다. - resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다. - resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다. - resource의 컬렉션 이름과 스토어 이름으로는 복수 명사를 사용해야 한다. 예) GET /Member/1 → GET /members/1
*자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.
- URI에 HTTP Method가 들어가면 안된다. 예) GET /members/delete/1 → DELETE /members/1 - URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.) 예) GET /members/show/1 → GET /members/1, GET /members/insert/2 → POST /members/2 - 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, id는 하나의 특정 resource를 나타내는 고유값이다.) 예)student를 생성하는 route: POST /students, id=12인 student를 삭제하는 route: DELETE /students/12
ⅲ. 하이픈(- )은 URI 가독성을 높이는데 사용, 언더바(_)를 대신 사용하지 않는다.
- 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
ⅳ. 밑줄(_ )은 URI에 사용하지 않는다.
- 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
ⅴ. URI 경로에는 소문자가 적합하다.
- URI 경로에 대문자 사용은 피하도록 한다. - RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
ⅵ. 파일확장자는 URI에 포함하지 않는다.
- REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다. - Accept header를 사용한다. 예) http://restapi.example.com/members/soccer/345/photo.jpg (X) 예) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)
ⅶ. 리소스 간에는 연관 관계가 있는 경우
- /리소스명/리소스 ID/관계가 있는 다른 리소스명 예) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)
cURL(Client URL)은 1997년 출시된 다양한 통신 프로토콜들을 이용하여 URL로 데이터를을 전송하여 서버의 데이터를 보내거나 가져올때 사용하기 위한 명령줄 도구 및 라이브러리로 명령줄이나 스크립트에서 HTTP/S로 GET,POST등으로 데이터(패킷/메시지)를 전송하는 데 사용한다.
예) 자바스크립트 환경에서 REST API(http)를 테스트하고싶다면 보통 ajax, fetch 를 이용해 요청을 보내는 것과 같이,
SHELL(커맨드라인 환경)에서 REST API(http) 테스트 하고 싶으면 curl 명령어를 이용하면 된다라고 보면 된다.
이밖에 HTTP / HTTPS / FTP / LDAP / SCP / TELNET / SMTP / POP3 등 다양하고 주요한 프로토콜을 지원하며 Linux/Unix계열 및 Windows 등의 OS에서 구동됨으로 여러 플랫폼과 OS에서 유용하게 사용할 수 있다. 이렇게 다양하고 강력한 기능을 가진 옵션들을 제공하지만, 보통 특정 서버에서 빠르게 방화벽 예외 상태를 테스트 하거나, REST 서비스 테스트를 위해 사용되는 편이다.
-O : 파일 다운로드 (ex : curl -O http://해당경로) -i : 헤더값 확인
-A : 에이전트 추가 -I : 사이트의 Header와 바디 정보를 함께 가져오기 -v : request, response 어떻게 오가는지 상세로그 확인 (헤더, 바디) -k : https 사이트를 SSL certificate 검증없이 연결. -s : 정숙 모드. 진행 내역이나 메시지등을 출력하지 않음. -H : 헤더 설정. 헤더 정보 전달
-h : 옵션 보기 -d : HTTP Post data (FORM 을 POST 하는 HTTP나 JSON 으로 데이타를 주고받는 REST 기반의 웹서비스 디버깅시 유용한 옵션)
. 국가에서 감정평가를 한 토지의 가격 . 국세 및 지방세의 부과하는 기준이 됨 . 표준 공시지가는 매년 1월 1일 조사하여 2월말에 발표
공시지가란 국가에서 토지 단위당 면적(㎡)을 감정평가를 하여 매긴 가격으로 건물이 아닌 토지에 대한 금액이며, 국가에서 토지 관련 국세 및 지방세, 종합부동산세를 납부하게 되는 부과 기준이된다. 토지를 보유하고 있다면 공시지가를 기준으로 세금의 금액이 결정되며, 새로운 아파트 및 상업지구를 만들게되는 토지 개발에 대한 금액에 대한 기준으로도 활용된다. 표준 공시지가는 국토교통부에서 매년 1월1일 대표적으로 기준이 될 수 있는 필지만을 조사를 시작하여 2월 말에 발표한다.
공시지가는 표준지 공시지가와 개별 공시지가 2종류가 있다.
1)표준지 공시지가 ( 국토교통부 부동산 공시가격 알리미로 조회 https://www.realtyprice.kr/notice/gsstandard/search.htm ) 표준지 공시지가는 한 지역의 대표되는 땅(표준지)의 금액을 감정 평가한것으로, 개별 공시지가의 산정 기준이 되기도 하며 국토교통부에서 발표한다. *표준지 공시지가 조회 방법 ①국토교통부 "부동산 공시가격 알리미" 접속 ②상단 메뉴의 "표준지 공시지가" 클릭 ③"텍스트검"색 또는 "지도검색" 선택 ④검색년도, 시/도, 시/군/구, 읍/면/동 지역 선택 후 검색 ⑤표준공시지가 조회 완료 - 소재지, 면적(㎡), 지목, 공시지가(원/㎡), 지리적위치, 용도지역, 주위환경, 도로교통, 형상지세 정보 확인가능
표준지로 선정된 토지의 도로 및 교통여건과 규제등을 고려하여 적정 가격을 평가하며 시.군.구청장이 발표한다.
*개별공시지가 조회 방법
①지역별 부동산 정보조회 시스템 홈페이지 접속 ②지번입력 또는 도로명주소입력을 선택 ③주소 설정후 조회 ④개별 공시지가 조회 완료
- 기본, 토지, 건축물, 토지이용계획, 개별공시지가(기준년도,토지소재지,지번,개별공시지가) 정보 확인 가능
2.공시가격 이란?
. 국가에서 감정평가 한 주택 (건물 및 부수토지)의 가격 . 재산세, 종합 부동산세 및 지역건강보험료와 국민연금액 납부액의 기준이 됨 . 공시가격은 1년에 2회 발표하며, 4월 말과 9월 말에 각각 1회씩 발표
공시가격은 국가에서 주택(건물 및 부수토지)을 감정평가를 하여 매긴 가격으로 단독주택 과 아파트 및 빌라등의 공동 주택을 보유하고 있다면 공시가격을 기준으로 재산세 와 종합부동산세 등의 세금 부과 기준이 되며 1년에 2회 발표하며, 4월말과 9월말에 한번씩 발표하게 된다. 실제 시세와는 차이가 있으며 부동산 거래시 대출의 기준이 되며 6월 1일에 보유한 부동산에 부과하고 12월에 납부하는 종합부동산세 와 7월, 9월에 납부하게되는 재산세, 지역건강보험료와 국민연금액 납부 금액의 기준이 된다.
단독주택 가격공시는 단독으로 있는 주택의 가격공시를 진행한것이고 표준주택 가격공시는 지역의 기준이 되는 가격을 공시한 내용이며, 개별주택 가격공시는 표준주택 가격공시를 기준으로 국가에서 평가를 한 것이다.
2) 공동주택 가격공시
공동주택 가격공시는 아파트/ 빌라/ 다세대 등의 주택 가격을 평가한 것이다.
공시지가 및 공시가격의 불만이 있거나 정확한 금액이 아닌거 같다는 생각이 들면 이의 신청을 해볼 수 있으며 이의 신청 기간(1월기준공시: 4월말~5월말, 6월기준 공시: 9월말~10월말 상세일정은 "부동산 공시가격 알리미"에서)내 "부동산 공시가격 알리미"에 할 수 있다.
*이의 신청 방법
① "부동산 공시가격 알리미"의 소정양식 게시판에 의견을 기재 후 등록 ② 공동주택가격 이의 신청서를 해당 공동주택 소재를 관할하는 시,군,구(읍면,동) 민원실에 팩스,우편 또는 직접제출 ③ 공동주택가격 이의 신청서를한국부동산원 지사에 팩스,우편 또는 직접제출
이의 신청 기간은 1월1일 발표 기준공시는 4월말~5월말까지, 6월1일 발표 기준공시는 9월말~10월말까지 신청이 가능하다.
3. 아파트 공시지가
매년 1회, 1월1일에 공동주택가격공시가 발표되며 공동주택 가격공시를 통해 세금의 납부 기준이 되게된다. 아파트 공시가격 즉, 평가된 금액이 적정하지 않다는 생각과 불만이 생긴다면 아파트 공시가격에 이의 신청을 할 수 있다.
이의 신청을 통해 금액 조정이 어렵지만 될 수도 있기 때문에 평가된 아파트의 공시가격이 불만족 스럽다면 이의신청을 한다.
② 상단메뉴의 "공동주택 공시가격" 클릭 ③ 시/도 선택, 시/군/구 선택, 도로명 선택 ④ 단지명, 동/호 선택 ⑤ 아파트 공시지가(공시가격) 조회 완료 - 공시기준일, 단지명, 동, 호, 전용면적(㎡), 공동주택의 공시가격 확인 가능
4. 오피스텔 기준시가(공시지가)
주로 공시지가는 부동산과 담보 대출 및 세금 및 부동산 시세등을 파악을 위해 조회를 하게되는데 오피스텔 공시지가는 정확한 명칭은 "공시지가"가 아니라 "기준시가" 라고 한다. 오피스텔과 상가의 기준시가(공시지가)는 국토교통부 "한국부동산 공시 가격알리미"가 아닌 국세청 "홈택스"에서만 조회가 가능하다. 기준시가는 토지 및 건축을 포함한 상업용 건물과 오피텔의 금액을 국세청에서 산정하게 되며, 상속세 및 증여세, 양도소득세의 과세 기준이 되며, 매년 1회 4월말에 발표한다.
◆ 오피스텔 기준시가(공시지가) 조회 방법 -기준시가는 서울, 경기, 인천과 5대 지방 광역시, 세종특별자치시에 위치한 경우만 조회 가능 ①국세청 홈택스 홈페이지에 접속 https://www.hometax.go.kr/ ② "조회/발급" 메뉴 클릭 > "기타 조회" 메뉴의 "기준시가 조회" 클릭
⑥ 오피스텔 기준시가 조회 완료 -오피스텔의 단위당 면적(㎡)당 기준시가(원)와 건물 면적(㎡) 확인 가능
오피스텔 기준시가(공시지가) 조회가 안되는 경우 정확한 법정동 주소를 입력하지 않아서 이거나 신축건물이라 조회가 되지 않는 경우도 있다. 신축건물이라면 4월말에 기준시가가 발표됨으로 5월에 다시한번 조회하면 조회 될 것이다.
5.상가 기준시가(공시지가)
부동산을 보유하고 있으면 일반적 경우는 공시지가 조회로 세금 및 대출 자금의 규모를 확인해 볼 수 있는데, 상가와 오피스텔의 경우는 공시지가가 별도로 존재하지 않으며 기준시가를 기준으로 국가에서 세금을 징수한다. 기준시가는 공시지가와 달리 토지와 건축까지 포함한 오피스텔 과 상업용 건물 금액을 국세청에서 가액을 산정하게 되는데, 양도소득세 및 상속, 증여세등의 과세기준이 되며, 매년 1회, 4월 말에 국토교통부가 아닌 국세청에서 발표한다.
◆상가 기준시가(공시지가) 조회 방법 ①국세청 홈택스 홈페이지에 접속https://www.hometax.go.kr/ ②"조회/발급" 메뉴 클릭 > "기타 조회" 메뉴의 "기준시가 조회" 클릭
⑥ 상가 기준시가 조회 완료 -상가의 단위당 면적(㎡)당 기준시가(원)와 건물 면적(㎡) 확인 가능
상가의 기준시가(공시지가)조회가 안되는 경우는 면적이 3,000㎡ 이상 이거나 호실이 100개 이상인 상업용 건물 이어야 조회가 가능하며, 두 조건이 충족한데 기준시가(공시지가)가 나오지 않으면 신축건물이라 조회가 되지 않는 경우가 있다. 신축건물이라면 오피스텔과 같이4월말에 기준시가가 발표됨으로 5월에 다시한번 조회하면 조회 될 것이다.
