API nodejs 에서 사용하기 (feat.postman)

API(Application Programming Interface 애플리케이션 프로그래밍 인터페이스, 응용 프로그램 프로그래밍 인터페이스)는 응용 프로그램에서 사용할 수 있도록, 운영 체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있게 만든 인터페이스를 뜻한다.

 

라고 하지만 현업에서 느낀 바로는 .. 

 

API는 프론트단과 관계 없이 테스트를 할 수 있게 만들어 협업할 때 용이하다.

API는 프론트단에서 URL을 호출하는 것과 같은 의미를 지닌다. 우리는 URL을 호출할때 GET이나 POST 방식으로 파라미터, JSON FORM DATA를 주고 받는다. 그러한 것들을 임의적으로 도와주는 것이 API이다.

협업시, 아직 프론트단이 만들어지지 않았을 때 아니면 간단히 백단(서버)를 테스트해보고 싶을 때

API를 사용한다.

 

API 예 (NodeJS ExpressJS 사용)

GET 방식

1. Express 모듈 만들기

vcode에서

 

npm install -g express-generator 
express -e
npm install

 

***에러날 떄 : powershell에서 하지말고 cmd에서 해야함***

2. controller 만들기 

 

router/index.js

router/index.js에 컨트롤러 설정

파라미터를 받지 않는 getParam

파라미터를 받는 getQuery 선언

 

index.ejs 선언 - 받아온 param 값 뿌리기

 

3. API 테스트

postman을 설치 후 

 

getParam 입력

getParam URL을 작성후 SEND 클릭 (GET 방식)

getParam에서 부르는 CALL getParam이 잘 가져왔음을 확인 할 수 있다.

 

이번엔 getQuery를 실행시킴

?param=hello 다음으로 오는게 QueryString이라는 건데 router/index.js에서 req.query를 사용해 값을 받을 수 있다. 

밑에 결과값도 'hello'가 잘 적용됨을 확인 할 수 있다.

 

POST 방식(JSON)

 

router/index.js

 

views/index.ejs

post 방식으로 작성한 후 req.body를 통해 json을 가져옴

 

post-json

JSON의 key, value값을 입력 (Body - raw 설정해주기)

POST로 설정하고 SEND클릭

 

job과 old의 value가 잘 표현됨을 볼 수 있다.

 

POST 방식(FORM)

router/index.js

 

index.ejs

postman

POST, Body- x-www-form-urlencoded 클릭 후 send

값이 잘 들어왔음을 확인할 수 있음

 

 

 

 

참고코드 : https://github.com/datoybi/blog-posting/tree/main/api-postman

GitHub - datoybi/blog-posting: code examples posted on my blog

JSON Array 형태로 보내고 싶을 때 참고 : https://tyson.tistory.com/205

Postman JSON 전송시, Object ,Array 보내기 (Unexpected token o in JSON at position 1 에러)