TIL

항해99_TIL220525 (RESTful한 API)

Hyeongjun_Ham 2022. 5. 26. 00:33

오늘 강의 듣고, 팀원들과 어제 짠 코드들 리뷰하는데 내가 짠 코드가 너무 별로고, 잘못 짰다는 것을 알았다.

 

핵심 비지니스 로직을 Service에서 처리해야하는데 Controller에서 처리를 너무 많이하고 있었다.

 

Dto설정도 3개로 나눠서 했는데 얘기하다보니 두개로 설정 가능 할것 같다.

 

여러모로 잘못짰다. 그래도 구조, 돌아가는 방식 등을 더 잘 이해하게 돼서 기분은 좋았다.

 

반환타입 뽑아내는 단축키 : ctrl alt v
메소드로 뽑는 단축키 : ctrl alt m
같이 사용되는거 이름 바꾸기 : shift F6
자동으로 테스트파일 만들기 : ctrl shift T
Inline variable : ctrl alt N(리턴값, 변수가 동일할 때 변수 선언 없이 바로 리턴에서 작성)

 

- REST API

마침 오늘 항해 톡에서 다뤄진 주제로 좀 더 쉽게 접할 수 있었다.

REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약할 수 있습니다.

 

첫 번째, URI는 정보의 자원을 표현해야 한다.
두 번째, 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.


REST 의 특징
1) Uniform (유니폼 인터페이스)
Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말합니다.

2) Stateless (무상태성)
REST는 무상태성 성격을 갖습니다.

작업을 위한 상태정보를 따로 저장하고 관리하지 않습니다.

세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 됩니다. 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해집니다.

3) Cacheable (캐시 가능)
REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능합니다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능합니다.

HTTP 프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능합니다.

4) Self-descriptiveness (자체 표현 구조)
REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다는 것입니다.

5) Client - Server 구조
REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 됩니다.

6) 계층형 구조
REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 합니다.

 

- 포트포워딩 확인, 및 삭제방법

포트를 이전에 5000번을 연적이 있어서 그런지 8080열고 포트포워딩해도 80번을 인식을 못했다.

이전 포트포워딩 삭제하니 제대로 작동

출처 : https://kelly-tech.tistory.com/32

 

03/25(Thu) 포트포워딩이 안될 때

🚩 이상하게 포트포워딩만 안된다? 원인을 알아보자 과제 시작 전에 week04 배포하기 전에도 포트포워딩만 안됐었다. '아이피 주소:8888' 는 잘 되는데, 포트포워딩 후 8888을 떼버리면 웹사이트가

kelly-tech.tistory.com

 

 

- RequestParam ,PathVariable

이걸로 3시간은 토론했다.

req.param

주소에 포함된 변수를 담는다. 예를 들어 https://okky.com/post/12345 라는 주소가 있다면 12345를 담는다

서버에서 PathVariable로 칭한다.

req.query

주소 바깥, ? 이후의 변수를 담는다. 예를 들어 https://okky.com/post?q=Node.js 일 경우 Node.js를 담는다

&로 연결하여 여러개의 데이터를 넘길 수 있다.

서버에서 Queryparameter로 칭한다.

 

아직도 제대로 모르겠다. 내일 질문해야지

 

- 내일 할 일

- 배포 마무리(준비는 끝)

- 스프링 강의 듣기