API 플레이그라운드 사용하기
n8n v2.29이 문서 사이트는 호출을 테스트해볼 수 있는 플레이그라운드를 제공합니다. 이 사이트의 엔드포인트 참조에서 API 호출을 테스트할 수 있습니다. n8n은 이 기능을 구현하기 위해 Scalar's 오픈 소스 API 플랫폼을 사용합니다.
이 문서 사이트는 호출을 테스트해볼 수 있는 플레이그라운드를 제공합니다. 셀프 호스팅 사용자는 인스턴스의 일부로 호스팅되는 내장 플레이그라운드에도 접근할 수 있습니다.
문서 플레이그라운드#
이 사이트의 엔드포인트 참조에서 API 호출을 테스트할 수 있습니다. 서버의 기본 URL과 인스턴스 이름을 설정하고 API 키를 추가해야 합니다.
n8n은 이 기능을 구현하기 위해 Scalar's 오픈 소스 API 플랫폼을 사용합니다.
노출된 API 키와 데이터
플레이그라운드를 사용할 때는 범위가 제한된 테스트 API 키와 테스트 데이터를 사용하세요. 플레이그라운드에서의 모든 호출은 Scalar의 프록시 서버를 통해 라우팅됩니다.
실제 데이터
여러분은 실제 라이브 데이터에 접근할 수 있습니다. 이는 요청을 시험해보는 데 유용합니다. 실제 데이터를 변경하거나 삭제할 수 있다는 점에 유의하세요.
내장 플레이그라운드#
기능 가용성
API 플레이그라운드는 Cloud에서는 사용할 수 없습니다. 모든 셀프 호스팅 요금제에서 사용할 수 있습니다.
n8n API는 셀프 호스팅 버전에서 내장 Swagger UI 플레이그라운드와 함께 제공됩니다. 이는 요청을 시험해볼 수 있는 대화형 문서를 제공합니다. 플레이그라운드에 접근하는 경로는 호스팅 방식에 따라 다릅니다.
n8n은 환경 변수에 설정된 값으로부터 경로를 구성합니다.
N8N_HOST:N8N_PORT/N8N_PATH/api/v<api-version-number>/docs
API 버전 번호는 1입니다. 향후 여러 버전이 제공될 수 있습니다.
실제 데이터
API 플레이그라운드에서 Authorize를 선택하고 API 키를 입력하면 실제 라이브 데이터에 접근할 수 있습니다. 이는 요청을 시험해보는 데 유용합니다. 실제 데이터를 변경하거나 삭제할 수 있다는 점에 유의하세요.
API에는 자격 증명 형식에 관한 내장 문서가 포함되어 있습니다. 이는 credentials 엔드포인트를 사용해 확인할 수 있습니다.
N8N_HOST:N8N_PORT/N8N_PATH/api/v<api-version-number>/credentials/schema/{credentialTypeName}
credentialTypeName을 찾는 방법
유형을 확인하려면 워크플로를 JSON으로 다운로드하여 살펴보세요. 예를 들어 Google Drive 노드의 경우 {credentialTypeName}은 googleDriveOAuth2Api입니다.
{
...,
"credentials": {
"googleDriveOAuth2Api": {
"id": "9",
"name": "Google Drive"
}
}
}