Postman과 API

📖Postman

Postman 사용이유

브라우저의 주소창에 URL을 입력하면, 해당 URL의 root-endpoint로 GET요청을 보낼 수 있다. 하지만 테스트를 위해 GET요청이 아닌 다른 요청을 보내려면, 개발자 도구의 콘솔 창에서 Web API fetch를 사용해야 한다. 한마디로 매번 코드를 작성해서 데스트를 해야하는 것이다.

Postman과 같이 API 테스트 도구를 사용하면 매번 코드를 작성하지 않고도 간단하게 서버API를 테스트 해볼 수 있다.

Postman 사용방법

1. Workspaces에서 My Workspace를 클릭한 후 +를 눌러 테스팅을 시작
2. HTTP 메서드 선택과 URL 입력 후 Send

• 추가적인 파라미터 있으면 Params탭에서 입력
• POST요청과 같이 본문 포함하면 Body탭에서 raw 선택 후 JSON 선택해서 입력

📖API 작성 예시

• spinal-Case로 작성하는게 정석

유저정보에 대한 api작성

전체 유저 정보 조회

성공: 200 OK 실패: 400, 404
GET /users

개별유저정보를 조회

성공: 200 실패: 400, 404
GET /users/kimcoding

개별유저정보 추가

성공: 201 Created , 실패 400, 409 Conflict
POST/ users

• 구체적인 내용은 바디에 실어서 보낸다. 백엔드는 url이가 같아도 매서드에 따라서 로직을 다르게 구성하기 때문이다.

개별유저정보 갱신

전체 수정
성공: 200 ok, 204 No content 실패: 400, 404
PUT /users/kimcoding

부분 수정
성공: 200 ok, 실패: 400, 404
PATCH /users/kimcoding

개별 유저정보 삭제

성공: 204 nocontent, 200 ok 실패: 400, 404
DELETE /users/1

query parameters 예시