Express에서 제공하는 Node.js API 개발

Note: this post is not recomended for SSR or SR developers due to its simplicity.

간단한 개념 리뷰를 시작하겠습니다 💪

First of all let’s talk a little bit about client-server architecture . 이것은 일부 서비스(클라이언트)와 하나 이상의 서비스 제공자(서버)를 요청하는 하나 이상의 부분을 통신하는 방법을 정의하기 위해 강력하게 사용되는 모델입니다. 그 중 첫 번째는 웹사이트 또는 실제로 모바일 애플리케이션이 될 수 있고, 두 번째는 SOAP 웹 서비스, Rest API 등이 될 수 있습니다.
이 기회에 Rest API을 적용한 Node.js이라는 특정 서버 서비스에 대해 설명하겠습니다.

한 눈에 표현하기 👀

This amazing framework will help you build a robust Node.js Rest API. It’s important to know that there are other options to take into account like Sails , Meteor , Happi 등이 있습니다. 이 경우 가장 많이 사용되는 Express를 사용하지만 다른 것을 사용하는 데 제한이 없습니다. 전체 Express 문서를 읽을 수 있습니다here.

요구 사항 🛠

Node.js .

Nodemon (선택 사항) 코드에 변경 사항이 도입될 때 Rest API를 다시 로드하는 데 사용됩니다. 전역적으로 npm으로 설치할 수 있습니다: npm install -g nodemon , npx 과 함께 사용할 수도 있습니다.

설치 ⚙️

Once the repository is cloned you should install npm packages to be able to run it. To achieve this, just open a terminal on root directory and run the following command:

    npm install

💻 코드로 시작해 볼까요?

First of all, I will present the folder structure I chose. That’s so simply and I didn’t include some concepts like services or database acceses.

.
├── .env
├── .eslintrc.json
├── .gitignore
├── README.md
├── package-lock.json
├── package.json
└── src
    ├── common
    │   └── error.js
    ├── index.js
    ├── middlewares
    │   └── errors.js
    └── routes
        ├── index.js
        └── public.js

.env file contains environment variables and you must add this file because it won’t be pushed due to .gitigonore file. We will use API_PORT variable, then you need to add it just like API_PORT=20000 where 20000 is your desired port.
.eslintrc.json is used to follow some basic coding rules. You can use it or just ignore it.
.gitignore to defined everything you don’t want to push to git repository. Here is so import to add node_modules.
README.md just to show some information about the project.
package-lock.json keeps the packages dependencies tree tracked.
package.json has every needed dependency for this project.
src folder where will leave our core code.
- common folder to define common functions used along whole project.
- index.js that contains main API configuration.
- middlewares as the name says, contains every API middleware. In this case we only will use just one for error handling.
- routes folder where the API routing is defined. Here you can find every endpoint of the API.
  - index.js works like a routes mixer, just that.
  - public.js contains the unique endpoint we have.

달리기 ▶️

Once npm packages are installed you will be able to run the API. If you have installed nodemon you can run it with:

    nodemon ./src/index.js

Otherwise:

    node ./src/index.js

After this you should show a message like this on your terminal:

Node.js API listening on port: {Your port defined on .env}

At this point, you can go to your favourite browser, put http://localhost :{yourDesiderPort}/api/v1/en 및 응답이 다음과 같은지 확인합니다.

{
    "success": true,
    "message": "Node.js API - Hello world"
}

사용 가능한 엔드포인트 ✔️

GET /api/v1/:lang where lang is related to a language code. The possible values are ['en','es', 'it', 'fr'] . This endpoint will return a specific message depending on the language code sent.

Github 저장소 링크

You can access to the full code in this Github link

읽어 주셔서 감사합니다! 🙌

Reference

이 문제에 관하여(Node.js API 시작하기), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://dev.to/renacargnelutti/getting-started-with-node-js-api-3n99

텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.

우수한 개발자 콘텐츠 발견에 전념 (Collection and Share based on the CC Protocol.)

Node.js API 시작하기