[BE] URL, Request, Response의 개념과 예시 및 API 테스트 도구 Postman 사용법

URL, Request, Response의 개념과 예시

URL (Uniform Resource Locator)

개념: 인터넷 상에서 자원이 어디에 위치하는지를 알려주기 위한 규약입니다. 웹 브라우저 등의 클라이언트가 서버에 특정 자원을 요청할 때 사용하는 주소입니다.

구조: 프로토콜://도메인:포트/경로?쿼리스트링#앵커

예시: https://example.com:80/products?id=1&name=example#details

• https://  프로토콜
• example.com  도메인
• :80  포트
• /products  서버에서 자원을 찾기 위한 경로
• ?id=1&name=example  쿼리 스트링(서버에 전달하는 추가 정보)
• #details  앵커(해당 페이지 내에서 이동할 위치)

 

Request (요청)

개념: 클라이언트가 서버에 특정 작업을 수행하도록 요청하는 것입니다. HTTP 메소드(GET, POST, PUT, DELETE 등)를 포함하며, 필요한 데이터(페이로드)와 함께 서버에 전송됩니다.

구성 요소:

• HTTP  메소드 요청의 종류를 나타냅니다. (예: GET, POST).
• 헤더  요청에 대한 메타데이터 (예: Content-Type, Authentication).
• 바디  데이터를 담는 부분, 주로 POST나 PUT 요청에서 사용됩니다.

예시: POST 요청을 사용하여 JSON 형태의 데이터를 서버에 전송하는 경우

• HTTP 메소드  POST
• URL  https://example.com/api/products
• 헤더  Content-Type: application/json
• 바디  {"name": "Example Product", "price": 1000}

 

Response (응답)

개념: 서버가 클라이언트의 요청에 대해 반환하는 것입니다. 상태 코드(예: 200 OK, 404 Not Found)와 함께 데이터를 클라이언트에 전달합니다.

구성 요소:

• 상태 코드  요청의 처리 결과를 나타냅니다.
• 헤더  응답에 대한 메타데이터.
• 바디  요청에 대한 응답 데이터.

예시: 서버가 제품 정보 조회 요청에 대한 응답을 보내는 경우

• 상태 코드  200 OK
• 헤더  Content-Type: application/json
• 바디  {"id": 1, "name": "Example Product", "price": 1000}

 

 

API 테스트 도구 Postman 사용법

기본 사용법

1. Postman 설치  Postman 공식 웹사이트에서 설치 파일을 다운로드하고 설치합니다.
2. 새 요청 생성  Postman을 실행한 후, "New" 또는 "+" 버튼을 클릭하여 새 요청 탭을 엽니다.
3. 요청 구성  상단의 드롭다운 메뉴에서 HTTP 메소드를 선택하고, URL 입력란에 요청할 URL을 입력합니다.
4. 헤더 및 바디 설정  요청에 필요한 경우, "Headers" 탭과 "Body" 탭에서 헤더와 바디를 설정합니다. 바디는 주로 POST나 PUT 요청에 데이터를 포함시킬 때 사용합니다.
5. 요청 전송  "Send" 버튼을 클릭하여 요청을 서버에 전송합니다.
6. 응답 확인  요청을 보낸 후, Postman 하단의 "Response" 섹션에서 서버로부터의 응답을 확인할 수 있습니다. 상태 코드, 헤더, 응답 바디 등의 정보를 볼 수 있습니다.

 

추가 팁

• 환경 설정  Postman에서는 다양한 개발 환경(예: 개발, 스테이징, 프로덕션)을 위해 환경 변수를 설정할 수 있습니다. 이를 통해 URL, 인증 키 등을 쉽게 관리할 수 있습니다.
• 컬렉션  관련된 여러 API 요청을 그룹화하여 관리할 수 있습니다. 컬렉션을 사용하면 팀원과 API 요청을 공유하고 문서화하는 데 유용합니다.

 

이러한 과정을 통해 BE와 Swagger를 예로 든 API의 요청 및 응답 과정을 체계적으로 테스트하고, 개발 과정에서의 오류를 최소화할 수 있습니다.