✅ Postman 이란?

해당 글은 설치, 접속 방법이 주가 아닌 postman 코드 연결, 요청 확인등을 위주로 작성하였습니다! :)

"API의 개발을 빠르고 쉽게, 개발된 API를 테스트할 수 있고,팀원들간의 공유를 할 수 있게 해주는 플랫폼입니다."

✅ API 넌 누구?🧐

API란 Application Programming Interface의 약자입니다.

• Application

API의 맥락에서 애플리케이션이라는 단어는 고유한 기능을 가진 모든 소프트웨어를 나타냅니다.

• Interface

인터페이스는 두 애플리케이션 간의 서비스 계약이라고 할 수 있습니다.

interface를 쉽게 설명해보면 풀어보면, 어떤 두 매개체가 상호작용하여 영향을 끼칠 수 있는 어떠한 요소들을 의미합니다.요소들의 예시로 사람과 사람, 기계와 기계, 사람과 기계의 관계등을 나타낼 수 있습니다.

예시로 우리가 컴퓨터의 글을 입력하고 싶을때, 키보드를 사용해 글을 입력하게 될 것 입니다.
이때 우리가 사용한 키보드가 사람과 컴퓨터 사이에 인터페이스가 되는 겁니다.

• API

이 계약은 요청과 응답을 사용하여 두 애플리케이션이 데이터를 주고받는 방법이란뜻을 정의합니다.
이때는 컴퓨터끼리 데이터를 주고받는것이기 때문에 어떠한 양식이 필요할것이고
API 문서에는 개발자가 이러한 요청과 응답을 구성하는 방법에 대한 정보가 들어 있습니다.

✅ API 사용방법

여럿 공식사이트에 들어가면 각 회사의 API가 존재하는 곳이 있습니다.
해당 API에는 key가 존재 할 것이고, 그에따른 사용 방법이 적혀있으니 참고하면 될 것이다.

✅ API 예시를 통한 Postman 사용법

express.js를 통해 만든 간단한 API를 통해 Postman을 테스트 해보자
먼저 간단한 사용법을 순서대로 보여주면

사진에서 보이는 1번(new button)을 누른 후 2번(HTTP icon)을 선택해준다.

API에 작성한 요청(Get,Post등)을 적어주고 올바른 주소 값(localhost:3000)을 넣어준 후 API명령에 따라 작성해주면된다.


⚡️ 실전 사용

시작 전 서버를 꼭 켜주세요

✔️ Setting

//해당 란은 설정 값을 보여주기위해 작성되었습니다.
const express = require('express');
const app = express();
const cors = require('cors');
app.use(cors()); // 쿠키 파싱 미들웨어
app.use(express.json()); // JSON 요청 본문 파싱
// sample DB
![](https://velog.velcdn.com/images/yoon_min/post/1609075f-4394-4f99-8139-29d50e5ae60f/image.png)

//Port | 포트는 예제로 3003을 임의로 잡음
const PORT = 3003;
app.listen(PORT, () => {
    console.log(`서버가 http://localhost:${PORT}에서 실행 중`);
});

✔️ Get

먼저 간단한 get 요청을 postman으로 확인해보자

// 공개 라우트
app.get('/', (req, res) => {
    res.send('모든 사용자가 접근 가능');
});

해당 코드를 작성 후 Postman에서 정상작동하는지 요청을 받아보면

이렇게 잘받아오는걸 확인 할 수 있다.
다른 예시도 해보자

✔️ Post

해당 코드는 간단한 로그인 API입니다.

코드 주석을 잘보며 따라가시길 추천드립니다!

// Login API
app.post('/login', (req, res) => { //login 경로 request, response요청
    const {username, password} = req.body; // 요청 body에 username, password가 있어야해
    if (sample_db.id === username && sample_db.password === password) { //샘플 DB와 username과 password가 동일하다면
        const token = jwt.sign({ userId: sample_db.id, role: sample_db.role }, SECRET_KEY, { expiresIn: '1h' });//JWT 토큰을 1시간동안 생성해줘
        res.send({ token }); // response에 토큰을 넣어줘
    }
    else {
        res.status(401).send('Invalid username or password'); //틀리면 401 상태와 해당 메시지를 전송해줘
    }
});

자! 코드 주석을 잘 따라가며 봤으면 이제부터 Postman에서 요청해 확인해보도록 하겠습니다.

순서대로 따라와주세요

• 왼쪽 상단 빨간 박스부터 Post요청이었으니 Post로 변경합니다.
• /login으로 경로를 요청했으니 알맞게 변경합니다.
• code에서 body에 username, password 요청했으니 Body 선택합니다.

 const {username, password} = req.body; // 요청 body에 username, password가 있어야해

• Body 안에 raw 선택 후 sample_db에있던 데이터 값을 동일하게 넣어주고 send버튼을 누르면
• 성공적으로 전송(200 OK)가 완료되고
• JWT 토큰도 정상적으로 발급된 모습을 확인 가능합니다.

프로젝트 상단에서 문서화도 쉽게 가능합니다.


문서에 들어가 Publish 진행시 테스트 진행된 API들이 정리되기에 사용자에게 링크만 전달하게되면
보다 쉬운 협업이 가능합니다. 이점이 Postman에 가장 큰 장점이라 생각합니다.

해당 사진은 문서화가된 예시 사진입니다.

✨ Postman 정리

HTTP 요청 보내기
: GET, POST, PUT, DELETE 등의 HTTP 요청을 보낼 수 있다.
요청 파라미터 설정
: HTTP 요청에 필요한 파라미터를 쉽게 설정할 수 있다.
응답 확인
: HTTP 요청에 대한 응답을 확인하고, JSON, XML 등의 다양한 형식으로 응답을 처리할 수 있다.
히스토리 관리
: 이전에 보낸 HTTP 요청과 응답을 저장하고, 다시 사용할 수 있다.
환경 변수 설정
: 서로 다른 환경에서 동일한 HTTP 요청을 보내야 하는 경우, 환경 변수를 설정해 간편하게 처리할 수 있다.
API 문서화
: API 요청과 응답을 문서화하고, 다른 개발자와 공유할 수 있다.
Postman은 무료로 사용할 수 있으며, 다양한 템플릿과 예제 코드를 제공해주어 사용자가 더욱 효과적으로 API를 테스트하고 개발할 수 있도록 도와준다.

출처
velog | seunmini.log
velog | oka1313.log