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

소개

전체 과정에서 우리는 백엔드 아키텍처와 통신하고 데이터베이스에서 데이터를 가져오는 데 사용할 수 있는 매우 기본적인 RESTful API를 만드는 방법을 배웠습니다. 이 게시물에서는 기술적 사용법을 이해하기 위해 간단한 예제로 이 API를 로컬에서 테스트할 것입니다.

헬멧

첫 번째 단계는 헬멧이라는 새 패키지를 의존성에 설치하는 것입니다. 다양한 HTTP 헤더를 설정하여 앱을 자동으로 보호하는 데 사용됩니다.

npm i helmet

새 경로 폴더

다음으로 루트 디렉터리에 route라는 새 폴더를 만들고 이 폴더 안에 msgs.js라는 파일을 추가합니다. 이 파일은 하나 이상의 http 메서드(GET, POST, PUT, DELETE)를 포함하는 특정 경로(msgs 경로)를 나타냅니다.



이제 새로 생성된 이 msgs.js 경로를 열고 다음을 추가합니다.

import express from "express"

const router = express.Router()

const msgs = [
    {
        "id": "1",
        "content": "Hey there my friends!"
    },
    {
        "id": "2",
        "content": "Hello hello hello!"
    },
    {
        "id": "3",
        "content": "I hope everything is great!"
    },
    {
        "id": "4",
        "content": "How are you today?"
    }
];

router.get('/', (req, res) => {
    res.send(msgs);
});

export default router

index.js 수정

다음으로 index.js 파일을 다음과 같이 수정합니다.

import express from "express"
import cors from "cors"
import helmet from "helmet"
import msgsRoute from "./routes/msgs.js"

const app = express()
const port = process.env.PORT || 5000

const corsOptions = {
    origin: "*",
    "Access-Control-Allow-Origin": true,
    optionSuccessStatus: 200,
}

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

app.use("/msgs", msgsRoute)

app.get("/", (req, res) => {
    res.send("Welcome to our RESTful 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

설정에서 변경한 유일한 사항은 다음과 같습니다.

앱에서 헬멧 패키지 호출

corsOptions 객체를 초기화하고 cors()를 호출할 때 인수로 전달

msgs 경로를 호출하여 사용할 수 있습니다.

Thunder 클라이언트를 사용한 테스트

마지막으로 터미널을 열고 다음 스크립트를 입력합니다.

npm run start-dev

이제 서버가 활성화되었으므로 postman 과 같은 API 테스트 도구를 사용하여 API 끝점을 테스트합니다. 그러나 간단한 API 테스트를 위한 VS 코드 확장인 Thunder client을 사용하는 것을 선호합니다. 확장 프로그램을 설치한 후 왼쪽 표시줄에서 확장 프로그램을 열고(또는 ctrl + shift + p 및 Thunder 클라이언트 검색) 상단에 API 엔드포인트를 추가하고 보내기를 클릭합니다.

마지막 생각들

위의 예 전체에서 msgs 배열(데이터베이스 모델 시뮬레이션)을 수동으로 생성하고 API를 사용하여 해당 항목을 가져와 API를 로컬에서 테스트했습니다. 물론 이것이 거의 완벽하지는 않지만 초보자가 API가 일반적으로 작동하는 방식을 이해하기 위한 간단한 시작 방법일 뿐입니다. 이 블로그 게시물의 소스 코드를 보려면 here을 클릭하십시오. 다음 블로그 게시물에서는 이 API를 데이터베이스(MongoDB)와 연결하고 다른 http 메서드(PUT, POST, DELETE)를 사용하여 내 데이터베이스 컬렉션을 수정하겠습니다.

저는 웹 개발과 관련된 주제에 대한 전문 지식과 기술을 공유하는 새 블로그 게시물을 지속적으로 작성하고 있습니다. 개발 경력을 향상시키기 위해 이러한 주제에 관심이 있다면 저를 팔로우하십시오! 😇 아니면 내 개인website을 방문하세요 !
읽어주셔서 감사합니다, 차오! 👋