Developer Portal API Test

개요

이 튜토리얼은 개발자가 내장된 테스트 도구를 사용하여 개발자 포털에서 직접 API를 테스트하는 방법을 설명합니다. REST, GraphQL 및 WebSocket과 같은 여러 API 프로토콜을 지원하여 개발자가 포털을 떠나지 않고도 엔드포인트와 상호작용할 수 있습니다.

전제 조건

• 대상 API는 게이트웨이에 배포되고 게시되어야 합니다.
• API는 개발자 포털에서 볼 수 있는 제품의 일부여야 합니다.
• 개발자 포털에 로그인하고 API 제품에 접근할 수 있어야 합니다.

REST API 테스트

• 제품 세부 정보 페이지에서 API를 선택합니다.
• API의 테스트 탭으로 이동합니다.

예시:

필드	예시 값
메서드	GET
URL	https://echo.hoppscotch.io
헤더	선택 사항 (예: Authorization: Bearer token)
쿼리 매개변수	필요에 따라 추가합니다.

전송을 클릭하고 응답 본문, 상태 코드 및 헤더를 관찰합니다.

GraphQL API 테스트

• GraphQL 탭으로 전환합니다.
• 엔드포인트를 입력합니다 (예: https://echo.hoppscotch.io/graphql).
• GraphQL 쿼리를 작성합니다:

query Request {
	method
	url
	headers {
		key
		value
	}
}

연결을 클릭한 다음 쿼리를 실행합니다.

WebSocket API 테스트

• WebSocket 탭을 선택합니다.
• WebSocket 엔드포인트를 입력합니다 (예: wss://echo-websocket.hoppscotch.io).
• 연결을 클릭합니다.
• JSON 형식으로 테스트 메시지를 보냅니다:

{
"message": "Hello WebSocket"
}

서버에서 반환된 실시간 응답을 확인합니다.

모범 사례

• 공개 API를 시도할 때 테스트 환경이나 모의 서버를 사용합니다.
• 인증된 API의 경우, 헤더나 토큰을 수동으로 제공하십시오.
• 사용 가능한 경우 GraphQL introspection을 사용하여 스키마를 자동으로 로드하십시오.
• WebSocket의 경우, 핸드셰이크 및 메시지 프로토콜을 점진적으로 테스트하십시오.