MongoDB와 node.js를 활용 간단한 API 서버를 만들기

Copilot에 물어본다.

 

물론이죠! 몽고디비와 Node.js를 활용해서 간단한 API 서버를 만드는 방법을 안내해드릴게요. 이 예제에서는 Express.js를 사용하여 RESTful API를 구축하고, MongoDB와 연결하여 데이터를 저장하고 조회하는 기능을 구현해보겠습니다.

1. 프로젝트 설정
먼저, 프로젝트 디렉토리를 만들고 필요한 패키지를 설치합니다.
mkdir my-api-server
cd my-api-server
npm init -y
npm install express mongoose body-parser

2. 서버 설정
Express 서버를 설정하고, MongoDB와 연결하는 코드를 작성합니다.
JavaScript
// server.js
const express = require('express');
const mongoose = require('mongoose');
const bodyParser = require('body-parser');

const app = express();
const port = 3000;

// MongoDB 연결
mongoose.connect('mongodb://localhost:27017/mydatabase', {
  useNewUrlParser: true,
  useUnifiedTopology: true,
});

// 미들웨어 설정
app.use(bodyParser.json());

// 간단한 라우트
app.get('/', (req, res) => {
  res.send('Hello World!');
});

// 서버 시작
app.listen(port, () => {
  console.log(`Server is running on http://localhost:${port}`);
});
AI가 생성한 코드입니다. 신중하게 검토하고 사용하세요. FAQ의 자세한 정보.

3. 모델 생성
MongoDB에 저장할 데이터의 스키마와 모델을 정의합니다.
JavaScript
// models/User.js
const mongoose = require('mongoose');

const userSchema = new mongoose.Schema({
  name: String,
  email: String,
  password: String,
});

module.exports = mongoose.model('User', userSchema);
AI가 생성한 코드입니다. 신중하게 검토하고 사용하세요. FAQ의 자세한 정보.

4. 라우트 설정
사용자 데이터를 생성하고 조회하는 API 엔드포인트를 설정합니다.
JavaScript
// routes/user.js
const express = require('express');
const router = express.Router();
const User = require('../models/User');

// 사용자 생성
router.post('/users', async (req, res) => {
  try {
    const user = new User(req.body);
    await user.save();
    res.status(201).send(user);
  } catch (error) {
    res.status(400).send(error);
  }
});

// 사용자 조회
router.get('/users', async (req, res) => {
  try {
    const users = await User.find();
    res.status(200).send(users);
  } catch (error) {
    res.status(500).send(error);
  }
});

module.exports = router;
AI가 생성한 코드입니다. 신중하게 검토하고 사용하세요. FAQ의 자세한 정보.

5. 라우트 연결
서버 파일에서 라우트를 연결합니다.
JavaScript
// server.js
const userRouter = require('./routes/user');

app.use('/api', userRouter);
AI가 생성한 코드입니다. 신중하게 검토하고 사용하세요. FAQ의 자세한 정보.

이제 server.js 파일을 실행하면 간단한 API 서버가 동작하게 됩니다.

node server.js

이제 http://localhost:3000/api/users 엔드포인트를 통해 사용자 데이터를 생성하고 조회할 수 있습니다. 필요에 따라 추가적인 기능을 구현하거나, 보안 설정을 추가할 수 있습니다.

이 예제가 도움이 되었길 바랍니다! 추가적인 질문이 있으면 언제든지 말씀해주세요. 😊

 

순서대로 따라해본다.

PS D:\dev\my-api-server> node server.js
(node:24492) [MONGODB DRIVER] Warning: useNewUrlParser is a deprecated option: useNewUrlParser has no effect since Node.js Driver version 4.0.0 and will be removed in the next major version (Use `node --trace-warnings ...` to show where the warning was created)
(node:24492) [MONGODB DRIVER] Warning: useUnifiedTopology is a deprecated option: useUnifiedTopology has no effect since Node.js Driver version 4.0.0 and will be removed in the next major version Server is running on http://localhost:3000

 

mongoose 5.3.0 이상은 useNewUrlParser 안넣어도 된다고 해서 제거한다. useUnifiedTopology 옵션도 6.0 이상은 넣지 말라고 한다. 다 제거 하고 다시 돌려본다.

 

워닝 없이 잘 뜬다.

 

http://localhost:3000/ 접근하니 Hello World!, http://localhost:3000/api/users로 접근하니 [] 잘 뜬다. 

 

근데 사용자가 없으니 확인할 방법이 없다. 어떻게 추가하는지 다시 물어본다.

 

사용자를 추가하는 방법을 안내해드릴게요. 여기서는 MongoDB와 Node.js를 활용한 API 서버에서 사용자를 추가하는 방법을 설명하겠습니다.

사용자 추가 API 엔드포인트

1. 라우트 설정: 사용자 데이터를 추가하는 POST 엔드포인트를 설정합니다.
JavaScript
// routes/user.js
const express = require('express');
const router = express.Router();
const User = require('../models/User');

// 사용자 생성
router.post('/users', async (req, res) => {
  try {
    const user = new User(req.body);
    await user.save();
    res.status(201).send(user);
  } catch (error) {
    res.status(400).send(error);
  }
});

module.exports = router;
AI가 생성한 코드입니다. 신중하게 검토하고 사용하세요. FAQ의 자세한 정보.

2. 서버 파일에 라우트 연결: 서버 파일에서 라우트를 연결합니다.
JavaScript
// server.js
const userRouter = require('./routes/user');

app.use('/api', userRouter);
AI가 생성한 코드입니다. 신중하게 검토하고 사용하세요. FAQ의 자세한 정보.

3. 사용자 추가 요청: 이제 Postman이나 다른 API 클라이언트를 사용하여 사용자 데이터를 추가할 수 있습니다. 예를 들어, Postman에서 다음과 같이 요청을 보낼 수 있습니다.
• URL: http://localhost:3000/api/users
• Method: POST
• Body: JSON 형식
JSON
{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "password": "securepassword"
}

AI가 생성한 코드입니다. 신중하게 검토하고 사용하세요. FAQ의 자세한 정보.

이렇게 하면 새로운 사용자가 MongoDB에 추가됩니다. 추가적인 질문이 있으면 언제든지 말씀해주세요! 😊

 

POSTMAN 깔기 귀찮다. 더 편한 방법 알려달라고 다시 물어본다. 

 

물론입니다! Postman을 사용하지 않고도 간단하게 사용자 데이터를 추가할 수 있는 방법을 몇 가지 소개해드릴게요.

1. cURL 사용하기
cURL은 명령줄에서 HTTP 요청을 보낼 수 있는 도구입니다. 터미널이나 명령 프롬프트에서 다음 명령을 실행하면 됩니다:
curl -X POST http://localhost:3000/api/users \
-H "Content-Type: application/json" \
-d '{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "password": "securepassword"
}'

2. HTML 폼 사용하기
간단한 HTML 폼을 만들어 브라우저에서 사용자 데이터를 전송할 수도 있습니다. 예를 들어, 다음과 같은 HTML 파일을 만들어보세요:
HTML
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Add User</title>
</head>
<body>
  <form id="userForm">
    <label for="name">Name:</label>
    <input type="text" id="name" name="name" required><br>
    <label for="email">Email:</label>
    <input type="email" id="email" name="email" required><br>
    <label for="password">Password:</label>
    <input type="password" id="password" name="password" required><br>
    <button type="submit">Add User</button>
  </form>

  <script>
    document.getElementById('userForm').addEventListener('submit', async (event) => {
      event.preventDefault();
      const formData = new FormData(event.target);
      const data = Object.fromEntries(formData.entries());

      const response = await fetch('http://localhost:3000/api/users', {
        method: 'POST',
        headers: {
          'Content-Type': 'application/json'
        },
        body: JSON.stringify(data)
      });

      if (response.ok) {
        alert('User added successfully!');
      } else {
        alert('Failed to add user.');
      }
    });
  </script>
</body>
</html>
AI가 생성한 코드입니다. 신중하게 검토하고 사용하세요. FAQ의 자세한 정보.
이 HTML 파일을 브라우저에서 열고 폼을 제출하면 사용자 데이터가 서버로 전송됩니다.

3. REST 클라이언트 확장 프로그램 사용하기
브라우저에서 사용할 수 있는 REST 클라이언트 확장 프로그램을 설치할 수도 있습니다. 예를 들어, Chrome의 경우 "RESTer"나 “Talend API Tester” 같은 확장 프로그램을 사용할 수 있습니다. 이러한 도구를 사용하면 Postman 없이도 쉽게 HTTP 요청을 보낼 수 있습니다.

이 방법들이 도움이 되길 바랍니다! 추가적인 질문이 있으면 언제든지 말씀해주세요. 😊

 

curl이 젤 편해보인다. 그대로 날려본다.

PS D:\dev\my-api-server> curl -X POST http://localhost:3000/api/users -H "Content-Type: application/json" -d '{ >> "name": "John Doe", >> "email": "john.doe@example.com", >> "password": "securepassword" >> }' Invoke-WebRequest : 'Headers' 매개 변수를 바인딩할 수 없습니다. "System.String" 유형의 "Content-Type: application/json" 값을 "System.Collections.IDictionary" 유형으로 변환할 수 없습니다. 위치 줄:1 문자:49 + ... ://localhost:3000/api/users -H "Content-Type: application/json" -d '{ + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidArgument: (:) [Invoke-WebRequest], ParameterBindingException + FullyQualifiedErrorId : CannotConvertArgumentNoMessage,Microsoft.PowerShell.Commands.InvokeWebRequestCommand

 

명령프롬프트에서는 안난다고 해서 다시 날려본다.

C:\Users\AA>curl -X POST http://localhost:3000/api/users -H "Content-Type: application/json" -d '{"name": "John Doe", "e mail": "john.doe@example.com", "password": "securepassword"}'

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Error</title> </head> <body> <pre>SyntaxError: Unexpected token &#39;&#39;&#39;, &quot;&#39;{name:&quot; is not valid JSON<br> &nbsp; &nbsp;at JSON.parse (&lt;anonymous&gt;)<br> &nbsp; &nbsp;at createStrictSyntaxError (D:\dev\my-api-server\node_modules\body-parser\lib\types\json.js:169:10)<br> &nbsp; &nbsp;at parse (D:\dev\my-api-server\node_modules\body-parser\lib\types\json.js:86:15)<br> &nbsp; &nbsp;at D:\dev\my-api-server\node_modules\body-parser\lib\read.js:128:18<br> &nbsp; &nbsp;at AsyncResource.runInAsyncScope (node:async_hooks:206:9)<br> &nbsp; &nbsp;at invokeCallback (D:\dev\my-api-server\node_modules\raw-body\index.js:238:16)<br> &nbsp; &nbsp;at done (D:\dev\my-api-server\node_modules\raw-body\index.js:227:7)<br> &nbsp; &nbsp;at IncomingMessage.onEnd (D:\dev\my-api-server\node_modules\raw-body\index.js:287:7)<br> &nbsp; &nbsp;at IncomingMessage.emit (node:events:519:28)<br> &nbsp; &nbsp;at endReadableNT (node:internal/streams/readable:1696:12)</pre> </body> </html>

curl: (3) URL rejected: Malformed input to a URL function
curl: (3) URL rejected: Port number was not a decimal number between 0 and 65535
curl: (3) URL rejected: Bad hostname curl:
(3) URL rejected: Port number was not a decimal number between 0 and 65535
curl: (3) unmatched close brace/bracket in URL position 15:

 

다시 명령프롬프트에서 날리게 뽑아달라고 했다.

 

물론이죠! 명령 프롬프트에서 curl 명령어를 사용하여 사용자 데이터를 추가하는 방법을 다시 안내해드릴게요.

1. cURL 명령어 설치
먼저, Windows에 cURL이 설치되어 있는지 확인합니다. 만약 설치되어 있지 않다면 cURL 공식 사이트에서 다운로드하여 설치할 수 있습니다.

2. cURL 명령어 실행
명령 프롬프트를 열고 다음 명령어를 입력하여 사용자 데이터를 추가합니다:
curl -X POST http://localhost:3000/api/users ^
-H "Content-Type: application/json" ^
-d "{\"name\": \"John Doe\", \"email\": \"john.doe@example.com\", \"password\": \"securepassword\"}"

명령어 설명
• -X POST: HTTP POST 요청을 보냅니다.
• -H "Content-Type: application/json": 요청 헤더에 Content-Type을 JSON으로 설정합니다.
• -d "{\"name\": \"John Doe\", \"email\": \"john.doe@example.com\", \"password\": \"securepassword\"}": 요청 본문에 JSON 형식의 사용자 데이터를 포함합니다.

이 명령어를 실행하면 서버로 사용자 데이터가 전송되고, 새로운 사용자가 MongoDB에 추가됩니다.

추가적인 질문이 있으면 언제든지 말씀해주세요! 😊

 

C:\Users\AA>curl -X POST http://localhost:3000/api/users ^ More? -H "Content-Type: application/json" ^ More? -d "{\"name\": \"John Doe\", \"email\": \"john.doe@example.com\", \"password\": \"securepassword\"}" {"errorResponse":{"index":0,"code":13297,"errmsg":"db already exists with different case already have: [myDatabase] trying to create [mydatabase]"},"index":0,"code":13297}

 

이전에 myDatabase 만든적 있어서 나는 문제이다. MongoDB Compass 에서 날리고 다시 날려본다.

C:\Users\AA>curl -X POST http://localhost:3000/api/users ^ More? -H "Content-Type: application/json" ^ More? -d "{\"name\": \"John Doe\", \"email\": \"john.doe@example.com\", \"password\": \"securepassword\"}" {"name":"John Doe","email":"john.doe@example.com","password":"securepassword","_id":"66ea4f5395effe5559d3ad3a","__v":0}

 

 

이제 http://localhost:3000/api/users 로 접근하면 보인다. 오늘은 여기까지