node.js를 사용하여 쉽게 RESTful API 만들기 | 1 부

RESTful API란 무엇입니까?

먼저 API는 Application Programming Interface의 줄임말로 둘 이상의 서비스 간의 통신 방법이며 때로는 사용자/클라이언트와 그들이 요청하는 리소스/서비스 간의 중재자로 설명되기도 합니다. 그러나 RESTful API는 REST 아키텍처 스타일의 제약 조건을 준수하여 RESTful 웹 서비스와의 통합을 허용하는 일련의 원칙입니다.

1단계: 새 프로젝트 초기화

첫 번째 단계는 선택한 디렉토리에 빈 폴더를 수동으로 생성하거나(오른쪽 클릭 사용) 터미널/Bash를 통해 생성하는 것입니다.

mkdir myProject
cd ./myProject

그런 다음 레거시 초기화를 사용하여 새 빈 npm 패키지를 설정합니다(질문 무시의 경우 -y).

npm init -y

먼저 컴퓨터에 node.js가 설치되어 있어야 합니다. 또 다른 참고 사항은 package.json 파일을 편집하고 이름(작성자), git repo, 설명 등과 같은 지정된 정보를 추가할 수 있다는 것입니다.

2단계: 필요한 종속성 설치

매우 간단한 RESTful API를 만들기 위해 가장 기본적인 설정을 사용하겠지만 유용하다고 생각되는 다른 패키지를 확실히 추가할 수 있습니다. 내가 사용할 두 가지 주요 패키지는 워크로드를 단순화하는 데 사용되는 최소 node.js 프레임워크인 express와 Cross-Origin-Resource-Sharing을 처리하는 CORS입니다.

npm i express cors

또한 디렉토리에서 파일 변경이 감지되면 노드 애플리케이션을 자동으로 다시 시작하는 도구인 nodemon을 사용할 것입니다.

npm i --save-dev nodemon

단계. 3: 진입점 만들기

다음 단계는 프로젝트 루트 내에 node.js 애플리케이션(일반적으로 index.js라고 함)의 진입점을 만드는 것입니다. 그런 다음 package.json 파일을 다음과 같이 수정합니다.

{
  "name": "project-name",
  "version": "1.0.0",
  "description": "Add project description here if you want to",
  "main": "index.js",
  "type": "module",
  "scripts": {
    "start": "node index.js",
    "start-dev": "nodemon index.js",
  },
  "keywords": [],
  "author": "your-name",
  "license": "ISC"
}

애플리케이션을 로컬(개발 환경)에서 실행하기 위해 두 번째 스크립트(start-dev)를 사용하고 첫 번째 스크립트는 프로덕션 환경 전용입니다. 또 다른 참고 사항은 package.json에 "type": "module"을 추가하면 ES6 기능을 사용할 수 있다는 것입니다.

다음으로 앱을 시작하기 전에 새로 생성된 index.js 파일을 열고 다음을 추가합니다.

import express from "express"
import cors from "cors"

const app = express()

app.use(express.urlencoded({ extended: false }))
app.use(express.json())
app.use(cors())

const port = process.env.PORT || 5000

app.get("/", (req, res) => {
    res.send("Welcome to our new custom API!")
})

app.use((req, res, next) => {
    const error = new Error("Something went wrong")
    error.status = 404
    next(error)
})
app.use((error, req, res, next) => {
    res.status(error.status || 500)
    res.json({
        error: {
            message: error.message,
        },
    })
})

app.listen(port, (err) => {
    if (err) throw new Error("Error while connecting to the server")
    console.log(`Server is live and running at: http://localhost:${port}`)
})

export default app

위의 설정 전체에서 몇 가지 유용한 익스프레스 메서드라고 하는 익스프레스를 사용하여 앱을 시작했으며 이전에 설치한 cors 패키지를 사용했습니다. 또한 포트 변수를 할당하고, API를 호출할 때 표시할 환영 메시지를 생성하고, 향후 예상하지 못한 오류를 간단히 처리했습니다. 마지막으로 우리는 맞춤형 포트에서 서버를 시작하기 위해 listen 메서드를 호출했습니다.

이제 터미널에서 다음 명령을 실행하십시오.

npm run start-dev

터미널에 제공된 Ctrl + 링크를 누르면 다음과 같이 localhost 서버가 실행됩니다.

마지막 생각들

이 예제 전체에서 우리는 매우 기본적인 RESTful API를 만들었습니다. 물론 완벽하지는 않지만 API를 위한 좋은 빌딩 블록입니다. 다음 부분에서는 API에 더 많은 기능을 추가하고 데이터베이스에 연결하거나 연결하지 않고 테스트합니다. 계속 지켜봐!