API 플레이그라운드 사용하기

n8n 공개 REST API를 테스트할 수 있는 플레이그라운드 사용 방법. 문서 플레이그라운드와 셀프 호스팅 전용 내장 플레이그라운드 이용 방법을 안내합니다.

이 문서 사이트에서는 API 호출을 테스트할 수 있는 플레이그라운드를 제공합니다. 셀프 호스팅 사용자는 자신의 인스턴스에 내장된 플레이그라운드에도 접근할 수 있습니다. 문서 플레이그라운드 # 이 사이트의 API 레퍼런스 에서 API 호출을 테스트할 수 있습니다. 서버의 기본 URL과 인스턴스 이름을 설정하고 API 키를 추가해야 합니다. n8n은 이 기능을 구현하기 위해 Scalar 의 오픈 소스 API 플랫폼을 사용합니다. API 키 및 데이터 노출 플레이그라운드 사용 시 제한된 스코프를 가진 테스트 API 키와 테스트 데이터를 사용하세요. 플레이그라운드의 모든 호출은 Scalar의 프록시 서버를 통해 라우팅됩니다. 실제 데이터 실제 데이터에 접근할 수 있습니다. 이는 요청을 테스트하는 데 유용하지만, 실제 데이터를 변경하거나 삭제할 수 있다는 점에 주의하세요. 내장 플레이그라운드 # Feature availability 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" } } }