Node.js로 5분만에 API 만들기 1

작성일 | In

많은 스타트업에서 NodeJS를 사용하는 이유가 배우기 쉽고, 개발 속도가 엄청나게 빨라서 라고 한다. 얼마나 빠르길래 그러는지 직접 사용해보기로 했다. 우선 아래 링크에서 Node.js를 다운 받고 설치부터 해야 한다. 대부분의 프로그램들이 그렇듯이 Install을 하면서 나오는 Next 버튼을 계속 눌러서 설치를 끝내면 된다.

🙋‍♂️NodeJS 다운로드

제대로 설치 되었는지는 터미널에서 아래 명령어들을 입력해보면 된다.

1
node -v 

1
npm -v

Node.js 버전과 npm(Node.js 패키지 관리자) 버전이 뜨면 정상적으로 설치 된 것이다.

VSC에서 Node.js 사용해보기

Visual Studio Code가 사전에 설치되어 있어야 한다. 프로젝트에 사용할 폴더 하나를 만들어 놓고 VSC에서 해당 경로에 들어간 다음, 터미널에 npm init을 입력하면 뭘 이것저것 입력하라고 한다. 우선 테스트 프로젝트이므로 엔터를 쳐서 넘겨도 상관없다. entry point : 부분에만 사용할 js 파일명을 입력해주면 되는데, 실수로 넘어갔어도 괜찮다. 입력이 끝나면 생성되는 package.json에서 수정할 수 있다. 나는 server.js 라는 이름으로 등록해두었다.

Package.json은 뭐하는 파일인가요?
내가 설치한 라이브러리 목록이 자동으로 기록되는 파일이다.

그런 다음 터미널에 npm install express를 입력해서 express 라이브러리를 추가해준다. express 라이브러리 덕분에 서버를 매우 쉽게 생성 할 수 있다.

서버를 띄워보자

위에서 지정한 이름으로 js파일을 만들고(내 경우에는 server.js) 서버를 띄워보자. express 라이브러리를 사용했기 때문에 아래와 같이 작성하기만 하면 서버를 띄울 수 있다.

1
2
3
4
5
6
7
const express = require('express'); //express 라이브러리 삽입 
const app = express(); //express 사용 

app.listen(8080, function() { //원하는 포트에 서버 오픈 
    console.log('listening on 8080')
})

이제 터미널에서 node server.js를 입력하면 서버가 실행된다.
브라우저에서 localhost:8080으로 접속해보면 위에 입력한 로그가 찍히는 것을 볼 수 있다.

GET 요청을 해보자

서버가 제대로 올라왔다면 API를 만들어 볼 차례다. /hello 라는 경로로 접속하면 안녕하세요! 라는 메시지를 띄워주는 서버를 만들어 보자. server.js 하단에 아래의 코드를 입력하기만 하면 된다.

1
2
3
4
app.get('/hello', function(req, res) { 
  res.send('안녕하세요!')
})

이제 localhost:8080/hello 로 접속하면 안녕하세요! 메시지를 확인 할 수 있다.
그냥 메시지만 띄우는 게 아니라 html 파일을 보여주고 싶다면? 이것도 30초면 가능하다.
server.js와 같은 폴더에 index.html을 생성해준다.

1
2
3
4
5
6
7
8
9
10
11
12
<!DOCTYPE html>
  <html>
  <head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>새 문서</title>
  </head>
  <body>
    <h4>안녕하세요 Node JS입니다.</h4>
  </body>
</html>

그런 다음 server.js로 돌아가서 아래의 내용을 추가해준다.

1
2
3
4
app.get('/', function(req, res) { 
  res.sendFile(__dirname +'/index.html')
});

이제 / 경로로 접속하면 index.html파일을 보내준다.

sendFile() 함수 : 파일 보내기
__dirname : 현재 파일 경로

📌매번 서버를 껐다 켜기 귀찮다면

API 하나 만들 때 마다 서버를 재시작 하는 건 귀찮다. npm install -g nodemon을 입력해서 nodemon을 설치해보자. 그런 다음 서버를 실행할 때 터미널에 nodemon server.js 라고 입력해주면 파일이 저장 될 때 마다 알아서 서버가 재실행 된다.

이제 서버 생성과 API 작성 방법을 알았으니 열심히~ 빠르게~ 개발을 해 보면 된다.
다음에는 Node.js에서 데이터를 저장하려면 어떻게 해야 하는지 알아보려 한다.