[Node.js] HTTP요청 ③ POSTMAN 설치 방법 / POST / PUT / DELETE

잡담

수업 정규과정이 거의 다 끝나갑니다. 이제 개인프로젝트나 팀프로젝트도 준비해야 되는데 아직도 모르는 게 산더미인데 과연 제가 해낼 수 있을까에 대한 고민을 많이 하고 있습니다. 오늘은 POST방식과 PUT / DELETE방식에 대해 공부하도록 하겠습니다. 

---

 

2. POST방식

Node.js의 Express 프레임워크에서 app.post() 메서드는 POST 요청을 처리하기 위한 라우팅을 설정하는 데 사용됩니다. 기본적인 app.post()의 구조는 다음과 같습니다:

app.post('/경로', (req, res) => {
    // POST 요청을 처리하는 로직
});

여기서 각 부분의 역할은 다음과 같습니다:

1. app: Express 애플리케이션의 인스턴스입니다. 이 인스턴스를 통해 Express의 메서드 및 속성에 접근할 수 있습니다.
2. post(): Express 애플리케이션 객체의 메서드 중 하나로, POST 요청을 처리하기 위한 라우팅을 설정합니다.
3. '/경로': POST 요청을 처리할 엔드포인트의 경로입니다. 클라이언트가 POST 요청을 보낼 때 이 경로와 일치하는 경우, 해당 콜백 함수가 실행됩니다.
4. (req, res): POST 요청을 처리하기 위한 콜백 함수입니다. 이 함수는 두 개의 매개변수를 받습니다. req는 클라이언트로부터의 요청을 나타내는 객체이고, res는 서버가 클라이언트에게 응답할 때 사용하는 객체입니다.
5. POST 요청을 처리하는 로직: 실제로 POST 요청을 처리하고, 필요한 작업을 수행하는 로직을 작성하는 부분입니다. 이 부분에서는 클라이언트로부터 받은 데이터를 처리하고, 데이터베이스에 저장하거나 다른 서비스로 전달하는 등의 작업을 수행할 수 있습니다.

아래는 기본적인 예제입니다.

const express = require('express')
const app = express()
const port = 3000

app.use(express.json());

let movieList = [
        { id: 1, title: '아바타 물의길', running: 130, rating: 9.5 },
        { id: 2, title: '반지의 제왕', running: 125, rating: 8.2 },
        { id: 3, title: '해리포터 불의잔', running: 135, rating: 8.5 }
]

app.post('/movies', (req, res) => {
        console.log('/movies(post)')
        console.log(req.body) //{ id: 4, title: '범죄도시4', running: 120, rating: 8.3 }
        movieList.push(req.body)
        res.send(movieList)
})

GET호출 방식은 해당 URL을 타고 들어가서 출력값을 확인할 수 있지만, POST방식을 통해 값을 전달하려면 값을 입력할 입력부를 만들어 줘야 하는데. POST방식을 확인하는 방법에는 여러 가지가 있는데 기본적으로는 HTML에 폼요소를 이용해서 값을 전달할 수 있습니다. 아래는 HTML 폼요소에 대한 예제입니다.

<form action="/submit" method="post">
  <input type="text" name="username">
  <input type="password" name="password">
  <button type="submit">제출</button>
</form>

하지만, TEST를 진행함에 있어서 TEST마다 HTML를 만들어 주면 효율적이지 못합니다. 그래서 인터페이스를 다운받아서 데이터를 전송하는 방법을 선택하겠습니다.

---

2. POSTMAN

Download Postman | Get Started for Free

Download Postman | Get Started for Free

Postman은 API 개발 및 테스트에 사용되는 강력한 도구로, 다음과 같은 장점이 있습니다:

1. 사용 편의성: Postman은 사용하기 쉬운 인터페이스를 제공하여 API 요청을 쉽게 만들고 관리할 수 있습니다. 사용자가 간단한 클릭만으로 요청을 만들고 보낼 수 있도록 도와줍니다.
2. 다양한 기능: Postman은 다양한 기능을 제공하여 API를 효율적으로 테스트할 수 있습니다. 예를 들어, 다양한 인증 방식을 지원하고, 환경 변수를 사용하여 요청을 구성하고 관리할 수 있습니다.
3. 컬렉션 관리: Postman은 요청을 그룹화하고 관리할 수 있는 컬렉션 기능을 제공합니다. 이를 통해 프로젝트의 여러 API 엔드포인트를 구성하고 쉽게 찾을 수 있습니다.
4. 자동화 및 스크립팅: Postman은 자동화 및 스크립팅을 지원하여 반복적인 테스트 작업을 자동화하고 테스트 스크립트를 작성할 수 있습니다. 이를 통해 테스트의 일관성을 유지하고 효율성을 높일 수 있습니다.
5. 다양한 환경 지원: Postman은 다양한 환경에서 사용할 수 있습니다. 데스크톱 애플리케이션 뿐만 아니라 웹 브라우저나 CLI(Command Line Interface)를 통해 사용할 수 있어서 사용자의 환경에 맞게 선택할 수 있습니다.

 

---

해당 링크를 타고 들어가서 Windows 64-bit 버튼을 클릭해서 다운로드를 시작합니다.

 

Method Type을 POST로 변경하고 전달할 URL을 입력합니다.

JSON형식으로 전달하기위해 JSON으로 변경하고 내용에 형식에 맞게 입력합니다. 여기서 주의할 점은 일반 JSON형식은 {id : 4, title : "범죄도시"}의 형식을 가지지만 Postman에서는 key값을 " " 로 묶어줘야 인식합니다.

ex)  {"id" : 4, "title" : "범죄도시"} 

완료했으면 SEND를 눌러 값을 입력합니다.

출력값

값이 위와 같이 나오지 않고 아래와 같이 나온다면 설정이 필요합니다.

undefined

코드에 express에서 json을 사용한다는 코드 한 줄을 적어주면 출력됩니다.

app.use(express.json());

 

---

3. PUT

PUT 방식은 HTTP 프로토콜에서 사용되는 메서드 중 하나로, 리소스의 전체를 업데이트할 때 사용됩니다. PUT 요청은 클라이언트가 서버에게 리소스의 URI(Uniform Resource Identifier)를 지정하고 해당 리소스를 요청 본문에 포함하여 전송합니다. 서버는 클라이언트가 보낸 리소스를 해당 URI에 업데이트하거나 새로 생성합니다.

PUT 요청의 특징은 다음과 같습니다:

1. 전체 업데이트: PUT 요청은 리소스의 전체를 업데이트합니다. 즉, 클라이언트는 전체 리소스를 요청 본문에 포함하여 보내야 합니다.
2. 멱등성: PUT 요청은 멱등성을 가지고 있습니다. 즉, 같은 요청을 여러 번 보내더라도 결과가 동일해야 합니다. 예를 들어, 같은 리소스를 여러 번 PUT 요청해도 동일한 상태가 유지되어야 합니다.
3. 캐시 제어: PUT 요청은 서버에 대한 캐시 제어에 사용될 수 있습니다. 서버는 클라이언트가 보낸 리소스를 캐시에 저장하거나 업데이트된 리소스를 새로운 캐시로 저장할 수 있습니다.
4. Idempotent: PUT 요청은 멱등성을 가지므로, 클라이언트가 요청을 여러 번 보내더라도 리소스의 상태가 변경되지 않거나 동일한 상태가 유지됩니다.

PUT 요청은 주로 RESTful API에서 사용되며, 클라이언트가 리소스를 업데이트하거나 새로운 리소스를 생성할 때 사용됩니다. 예를 들어, 블로그 포스트를 업데이트하거나 새로운 게시물을 작성하는 작업에 PUT 요청을 사용할 수 있습니다.

Node.js의 Express 프레임워크에서 PUT 요청을 처리하는 방법은 다음과 같습니다:

const express = require('express')
const app = express()
const port = 3000

app.use(express.json());

//put - http://localhost:3000/movies/2
app.put('/movies/:id', (req, res) => {
        console.log('/movies(put)')
        const id = parseInt(req.params.id)
        console.log(req.params)//{id:'2'}
        console.log(req.params.id)//2(String)
        console.log(id)//2(number)
        console.log(req.body) //{rating:8.8}
        const rating = req.body.rating
        for (var i = 0; i < movieList.length; i++) {
                if (id === movieList[i].id) {
                        movieList[i].rating = rating
                }
        }
        res.send(movieList)
})

이 코드는 Express 애플리케이션에서 PUT 메서드를 사용하여 영화 목록의 특정 영화의 평점을 업데이트하는 엔드포인트를 설정합니다. 요청의 URI에서는 /movies/:id 형식으로 영화의 ID를 동적으로 받아들입니다. 클라이언트는 업데이트할 영화의 ID와 새로운 평점을 요청 본문에 JSON 형식으로 전송합니다.

여기서 각 부분을 설명하겠습니다:

1. express와 app 객체를 가져오고 Express 애플리케이션을 생성합니다.
2. express.json() 미들웨어를 사용하여 요청 본문의 JSON 데이터를 파싱할 수 있도록 설정합니다.
3. PUT 메서드를 사용하여 /movies/:id 경로에 대한 라우트를 설정합니다. :id는 동적으로 변하는 영화의 ID를 나타냅니다.
4. 라우트 핸들러 함수에서는 클라이언트로부터 받은 요청의 파라미터와 본문을 확인하고, 해당 ID를 가진 영화의 평점을 업데이트합니다. 이때 받은 ID는 문자열 형태이므로 parseInt() 함수를 사용하여 숫자로 변환합니다.
5. 업데이트된 영화 목록을 응답으로 클라이언트에게 보냅니다.

이 코드는 예시로 제공된 것이며, movieList와 같은 데이터 구조가 정의되어 있지 않았기 때문에 실제로는 동작하지 않을 것입니다. 또한, 보안과 유효성 검사 등의 측면을 고려하여 실제 프로덕션 환경에서 사용하기 위해서는 추가적인 작업이 필요할 수 있습니다.

POSTMAN PUT

PUT을 통해 movieList의 id:2 인 rating 값을 8.8로 수정합니다.

출력값

id:2 인 영화의 rating이 8.8로 수정된 것을 확인할 수 있습니다.

 

---

 

4. DELETE

DELETE 요청은 HTTP 프로토콜에서 사용되는 메서드 중 하나로, 리소스를 삭제하기 위해 사용됩니다. DELETE 요청은 서버에게 특정 리소스를 삭제하도록 요청하는 메서드입니다. DELETE 요청의 특징은 다음과 같습니다:

1. 리소스 삭제: DELETE 요청은 서버에게 특정 리소스를 삭제하도록 요청합니다. 예를 들어, 웹 애플리케이션에서 사용자가 게시물을 삭제하는 경우 DELETE 요청을 보냅니다.
2. 멱등성: DELETE 요청은 멱등성을 가집니다. 즉, 같은 요청을 여러 번 보내더라도 결과가 동일해야 합니다. 예를 들어, 같은 리소스를 여러 번 DELETE 요청해도 해당 리소스는 한 번만 삭제됩니다.
3. 실패의 안정성: 만약 DELETE 요청이 실패하더라도, 리소스는 여전히 유지됩니다. 즉, 클라이언트가 DELETE 요청을 보내고 서버에서 오류가 발생하더라도 리소스는 삭제되지 않습니다.
4. 캐시 제어: DELETE 요청은 서버에 대한 캐시 제어에 사용될 수 있습니다. 서버는 클라이언트가 보낸 DELETE 요청을 캐시에 저장하거나 리소스의 삭제 상태를 새로운 캐시로 저장할 수 있습니다.
5. 안전하지 않은 메서드: DELETE 요청은 HTTP 메서드 중 안전하지 않은 메서드에 속합니다. 즉, DELETE 요청을 보내면 서버의 상태가 변경될 수 있습니다.

DELETE 요청은 RESTful API에서 자주 사용되며, 서버에서 리소스를 삭제하는 데 사용됩니다. 예를 들어, 사용자가 게시물을 삭제하거나 파일을 삭제하는 작업에 DELETE 요청을 사용할 수 있습니다.

const express = require('express')
const app = express()
const port = 3000

let movieList = [
        { id: 1, title: '아바타 물의길', running: 130, rating: 9.5 },
        { id: 2, title: '반지의 제왕', running: 125, rating: 8.2 },
        { id: 3, title: '해리포터 불의잔', running: 135, rating: 8.5 }
]

app.use(express.json());

//delete - http://localhost:3000/movies/2
app.delete('/movies/:id', (req, res) => {
        console.log('/movies/:id(delete)')
        console.log(req.params)
        console.log(req.params.id)
        const id = parseInt(req.params.id)
        console.log(id)//2
        let index = 0;
        for (var i = 0; i < movieList.length; i++) {
                if (id === movieList[i].id) {
                        index = i;
                }
        }
        //splice 메서드로 아이디 2번인 영화 데이터 삭제
        movieList.splice(index, 1)
        res.send(movieList)
})

이 코드는 Express 애플리케이션에서 DELETE 메서드를 사용하여 영화 목록에서 특정 영화를 삭제하는 엔드포인트를 설정합니다. 해당 엔드포인트는 /movies/:id 경로에 대한 DELETE 요청을 처리합니다. 클라이언트는 삭제할 영화의 ID를 동적으로 전달해야 합니다.

이 코드에서 각 부분을 설명하겠습니다:

1. DELETE 메서드를 사용하여 /movies/:id 경로에 대한 라우트를 설정합니다. :id는 동적으로 변하는 영화의 ID를 나타냅니다.
2. 라우트 핸들러 함수에서는 클라이언트로부터 받은 요청의 파라미터를 확인하고, 해당 ID를 가진 영화를 찾아 삭제합니다.
3. movieList.splice(index, 1) 코드를 사용하여 배열에서 해당 인덱스의 요소를 삭제합니다. 여기서 index는 삭제할 영화의 인덱스입니다.
4. 업데이트된 영화 목록을 응답으로 클라이언트에게 보냅니다.

이 코드는 올바른 요청이 오면 해당 ID를 가진 영화를 삭제하고 업데이트된 영화 목록을 반환합니다. 따라서 해당 경로로 DELETE 요청을 보내면 해당 ID를 가진 영화가 목록에서 삭제될 것입니다.

id:2 DELETE 출력값

 

---

 

 글을 마치며

오늘은 POST / PUT/ DELETE 방식에 대해 공부해 보았습니다. 해당 방식은 메모리상에서만 사용하고 있기 때문에 이렇게 공부하고 나면 이제 자연스럽게 다음단계가 구상이 됩니다. 바로 DB에 연결해서 값을 유지보수할 수 있게 하는 것입니다. Node.js 또한 DB에 연결해서 사용하는데 다음시간에는 MySQL을 연결하여 앞에서 배운 GET / POST / PUT / DELETE 방식을 이용해서 기본적인 CRUD의 형태를 만들어 보도록 하겠습니다. 감사합니다.