API Testing with Postman

GET을 테스트 해볼수 있는 사이트는 많은 것 같은데, POST, PUT, DELETE을 연습하기 위해서는 우리의 서버가 필요하다. Demo Server의 README 대로 따라하면 Postman 연습 서버를 구동할 수 있다.

Basic

서버를 실행하는 것을 간단히 살펴보자.

리포지토리 git clone 후

cd ./api-testing-foundations
npm install
node find_the_secret_server.js

http://localhost:3000/ 에 들어가보면,

GET

블로그 포스팅들을 보기 위해, GET 요청을 해보자.

http://localhost:3000/blogposts

블로그의 댓글도 가져와보자.

http://localhost:3000/blogposts?_embed=comments

결과

{
    "id": 1,
    "title": "My First Blog Post",
    "author": "Janice Jones",
    "comments": [
        {
            "id": 1,
            "body": "some comment",
            "blogpostId": 1
        }
    ]
}

POST

2번째 포스팅을 작성해보자.

아래 JSON을 body에다가 작성해주면 된다. (이쁘게 보기 위해, raw 선택후 JSON 선택)

http://localhost:3000/blogposts

{
    "id": 2,
    "title": "My 2nd Blog Post",
    "author": "Yoochul Kim"
}

다시 GET 요청을 하면 2번째 블로그가 추가됐다.

[
    {
        "id": 1,
        "title": "My First Blog Post",
        "author": "Janice Jones"
    },
    {
        "id": 2,
        "title": "My 2nd Blog Post",
        "author": "Yoochul Kim"
    }
]

PUT

http://localhost:3000/blogposts/1

1번째 블로그 포스팅의 제목을 바꿔보자.

{
    "id": 1,
    "title": "Changed my 1st blog post",
    "author": "Yoochul Kim"
}

바뀐 결과API 테스트 자동화API 테스트 자동화

[
    {
        "id": 1,
        "title": "Changed my 1st blog post",
        "author": "Yoochul Kim"
    },
    {
        "id": 2,
        "title": "My 2nd Blog Post",
        "author": "Yoochul Kim"
    }
]

DELETE

첫번째 블로그 글을 삭제해보자.

http://localhost:3000/blogposts/1

결과 (2번째 포스트만 남아있다)

API 테스트 자동화

컬렉션 변수 설정

Nationality를 캐나다로 설정해뒀다.

랜덤 유저 생성 API로 테스트 해보기

https://randomuser.me/api?nat={{Nationality}}

캐나다에 살고 있는 유저 정보를 랜덤으로 가져왔다,

결과

{
    "results": [
        {
            "gender": "male",
            "name": {
                "title": "Mr",
                "first": "Noah",
                "last": "Young"
            },
            "location": {
                "street": {
                    "number": 2961,
                    "name": "St. Catherine St"
                },
                "city": "Tecumseh",
                "state": "Nunavut",
                "country": "Canada",
                "postcode": "G6D 8I1",
                "coordinates": {
                    "latitude": "27.4730",
                    "longitude": "-52.1083"
                },
                "timezone": {
                    "offset": "-3:00",
                    "description": "Brazil, Buenos Aires, Georgetown"
                }
            },
            "email": "noah.young@example.com",
            "login": {
                "uuid": "bf54de9b-b8d5-4ea5-8257-d7f404a85e33",
                "username": "greenkoala861",
                "password": "bologna",
                "salt": "SFZv4Oub",
                "md5": "d80c5e8a00c67c9d4c1babcca7f054af",
                "sha1": "3776b56e72c961750d7eeaee25654052ffcd27ed",
                "sha256": "0b827a91d8a2a0c04ca8587af9092a45d7fb143d58a7d10865dd084f8a242a6c"
            },
            "dob": {
                "date": "1970-05-18T00:00:21.973Z",
                "age": 52
            },
            "registered": {
                "date": "2019-09-14T15:09:15.591Z",
                "age": 3
            },
            "phone": "036-539-2207",
            "cell": "752-132-5595",
            "id": {
                "name": "",
                "value": null
            },
            "picture": {
                "large": "<https://randomuser.me/api/portraits/men/29.jpg>",
                "medium": "<https://randomuser.me/api/portraits/med/men/29.jpg>",
                "thumbnail": "<https://randomuser.me/api/portraits/thumb/men/29.jpg>"
            },
            "nat": "CA"
        }
    ],
    "info": {
        "seed": "919c9daecdd726ca",
        "results": 1,
        "page": 1,
        "version": "1.3"
    }
}

DOC을 보면, 다른 나라들도 가능하다. (예, 독일 = DE)

값 검증 위한 테스트 스크립트

결과가 200이 오면, 테스트가 성공하는 자바스크립트 코드를 넣어줬다. 결과를 보면 패스한 것을 볼 수 있다. 안에 코드 문법은 chai assertaion library 를 사용한다. 코드는 자동으로 생성해주는 오른쪽 탭 snippets을 이용하면 편리하다.

다른 예제로, 리턴 받은 JSON의 이메일 값이 @ 기호 있나 확인해보기.

pm.test("Check email", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.results[0].email).include('@');
});

만약 컬렉션 안에 있는 모든 요청에서 테스트를 적용하고 싶다면, 다음과 같이 전역으로 추가하면 된다.

자주 사용되는 URL 같은 경우 환경에 추가한다.

환경 변수 사용을 위해선, 오른쪽 위에서 환경을 선택해줘야 한다. 눈 모양을 누르면, 지정한 값을 볼 수 있다.

다음과 같이 사용한다.

반복되는 코드를 Pre-request Script에 넣어줄 수 있다.

pm.sendRequest("<https://randomuser.me>", function(err, response){
    if (response.status == 'OK'){
        pm.environment.set("item", "true")
    }else{
        pm.environment.set("item", "false")
    }
})