REST (표상 상태 전이)는 여러 클라이언트가 사용할 수 있는 웹 API를 구축하는 표준이 되었습니다. REST API를 개발할 때, 요청 및 응답을 적절하게 처리하는지 확인하기 위해 테스트하는 것이 중요합니다. 이제 cURL을 사용하여 WebSocket API를 테스트하고 cURL 명령으로 REST API를 테스트하는 방법을 보여드리겠습니다. 한번 살펴봅시다.
방법 1. Apidog을 사용한 WebSocket 테스트를 위한 cURL
cURL은 HTTP 요청을 보내기 위한 명령줄 도구이며, Apidog은 WebSocket 테스트를 간소화하기 위한 그래픽 인터페이스를 제공합니다. Apidog은 cURL 명령을 수동으로 구성할 필요성을 없애, WebSocket 엔드포인트에 메시지를 생성하고, 저장하고, 보내는 것을 더 쉽게 만듭니다. 직관적인 인터페이스는 초보자와 경험이 있는 개발자가 WebSocket을 더 효율적으로 디버그할 수 있도록 도와줍니다.
WebSocket 요청을 생성하고, 메시지와 매개변수를 설정하고, 요청을 저장하고, WebSocket 서비스에 연결하고, WebSocket 요청을 보낼 수 있습니다. 이 접근 방식은 수동 cURL 명령의 복잡성을 없애 WebSocket 테스트를 더 접근 가능하게 만듭니다.
1단계. 검색창 옆에 있는 "+" 버튼을 클릭하여 WebSocket API를 생성할 수 있습니다.
New WebSocket API(Beta) 옵션이 드롭다운 메뉴에 있습니다. 이를 클릭하고 WebSocket API의 URL을 입력하여 연결을 설정하고 메시지를 전송/수신할 수 있습니다.
2단계.이제 메시지 섹션에서 서버에 전송해야 할 정보를 추가할 수 있으며, 서버는 이 정보를 받을 수 있습니다.
3단계. 요구 사항에 따라 매개변수를 설정할 수 있습니다. 데이터 유형을 문자열, 정수, 배열 등으로 설정할 수 있습니다.
4단계. 요청이 실행된 후에는 향후 사용을 위해 요청을 저장할 수 있습니다. 이렇게 하면 요청에 쉽게 접근할 수 있습니다.
5단계. 이제 WebSocket 연결을 설정하기 위해 WebSocket 요청을 보내고 연결할 수 있습니다. 검색창 옆에 있는 연결 버튼을 클릭하여 수행할 수 있습니다. 연결이 성공적으로 완료되면 성공 메시지를 확인할 수 있습니다.
5단계. 방금 생성한 WebSocket을 사용하여 서버와 통신할 수 있습니다. 전송 버튼을 클릭하여 메시지와 매개변수를 서버에 보낼 수 있습니다.
연결을 성공적으로 설정한 후 클라이언트와도 통신할 수 있습니다.
Apidog에서 cURL을 이용한 API 자동화
Apidog에서 cURL을 이용한 API 자동화는 Apidog 플랫폼 내에서 cURL 명령의 기능을 활용하는 것을 포함합니다. 이는 API 테스트와 상호작용을 간소화하고 자동화하는 데 도움이 됩니다. API 자동화를 달성하기 위한 단계별 가이드는 아래에 제공됩니다. 지금 Apidog에 cURL 명령을 가져와야 합니다.
Apidog 가져오기 창에 접속하고 제공된 텍스트 상자에 cURL 명령을 붙여넣습니다. 이렇게 하면 cURL 명령이 Apidog 플랫폼에 매끄럽게 통합됩니다. 이를 위해 어떤 패키지 캡처 도구를 사용할 수 있습니다.
다음으로, 자동화 설정을 구성해야 합니다. 설정 페이지로 이동할 수 있습니다. 자동화된 API 호출의 빈도를 설정하고 오류 처리를 거기에서 수행할 수 있습니다.
Apidog의 테스트 도구를 사용하여 자동화된 API 워크플로를 테스트하고 개선할 수 있습니다. 로그를 검토하고 성능 지표를 분석하며 신뢰성과 효율성을 최적화하기 위해 자동화된 API 호출을 조정할 수 있습니다.
방법 2. cURL 명령으로 REST API 테스트
REST API를 테스트하는 또 다른 간단한 방법은 터미널에서 cURL 명령을 사용하는 것입니다. cURL은 API를 테스트하기 위한 HTTP 요청을 만들 수 있는 명령줄 도구입니다. 이 섹션에서는 cURL을 사용하여 몇 가지 일반적인 API 시나리오를 테스트하는 방법을 알아보겠습니다.
GET 요청 테스트
API에서 리소스를 가져오는 테스트를 위해 cURL을 사용하여 GET 요청을 보낼 수 있습니다. 예를 들어:
cURL https://myapi.com/users/1
이는 /users/1 엔드포인트에 GET 요청을 보내고 원시 응답을 표시합니다.
-i 플래그를 추가하여 응답 헤더를 포함할 수도 있습니다:
cURL -i https://myapi.com/users/1
이는 API가 200 OK와 같은 올바른 상태 코드를 반환하는지 확인하는 데 도움이 됩니다.
POST 요청 테스트
리소스를 생성하는 테스트를 위해 POST 요청을 만들어야 합니다. 예를 들어, 새 사용자를 생성하려면:
cURL -X POST -H "Content-Type: application/json" -d '{"name":"John", "email":"john@example.com"}' https://myapi.com/users
여기서 -X POST를 사용하여 POST 요청을 만들고, -H로 Content-Type 헤더를 설정하고, -d로 JSON 페이로드를 전달합니다.
API는 성공 시 201 Created 상태를 반환해야 합니다.
PUT 및 PATCH 테스트
리소스를 업데이트하는 테스트를 위해, PUT 또는 PATCH 요청을 POST와 같이 보낼 수 있습니다.
예를 들어, PUT 요청으로 사용자의 이메일을 업데이트하려면:
cURL -X PUT -H "Content-Type: application/json" -d '{"email":"john@newdomain.com"}' https://myapi.com/users/1
그리고 PATCH 요청으로 사용자의 이메일을 부분적으로 업데이트하려면:
cURL -X PATCH -H "Content-Type: application/json" -d '{"email":"john@newdomain.com"}' https://myapi.com/users/1
DELETE 테스트
리소스를 삭제하는 테스트를 위해 DELETE 요청을 합니다:
cURL -X DELETE https://myapi.com/users/1
API는 성공 시 204 No Content 응답을 반환해야 합니다.
결론
cURL은 REST API 엔드포인트를 테스트하는 빠르고 쉬운 방법을 제공합니다. 다양한 유형의 요청을 쉽게 만들고 응답을 검사할 수 있습니다. 새로운 API를 개발할 때, cURL을 사용하여 CRUD 작업을 예상대로 처리하는지 검증해 보시기 바랍니다. 프론트 엔드와 통합하기 전에요.
