커뮤니티 노드 UX 가이드라인

커뮤니티 노드가 검증된 노드 후보가 되기 위해 따라야 하는 UX 가이드라인을 설명합니다.

노드의 UI는 검증된 커뮤니티 노드 후보가 되기 위해 이 가이드라인을 준수해야 합니다. 자격 증명 # API 키와 민감한 자격 증명은 항상 비밀번호 필드로 만들어야 합니다. OAuth # 가능한 경우 항상 OAuth 자격 증명을 포함하세요. 노드 구조 # 포함해야 할 작업 # 각 리소스 유형에 대해 CRUD 작업을 포함하도록 노력하세요. 각 리소스에 대한 노드에서 공통 작업을 포함하도록 노력하세요. n8n은 일관된 경험을 유지하고 사용자가 리소스에 대한 기본 작업을 수행할 수 있도록 일부 CRUD 작업을 사용합니다. 권장 작업은 다음과 같습니다. 생성(Create) 생성 또는 업데이트(Upsert) 삭제(Delete) 가져오기(Get) 여러 개 가져오기(Get Many): 필터링이나 검색이 가능한 경우에도 사용됩니다 업데이트(Update) 참고: 이 작업들은 리소스 자체 또는 리소스 내부의 엔터티(예: Google Sheet 내부의 행)에 적용될 수 있습니다. 리소스 내부의 엔터티를 대상으로 작업할 때는 작업 이름에 엔터티의 이름 을 명시해야 합니다. 노드와 리소스에 따라 명명이 달라질 수 있습니다. 자세한 내용은 다음 가이드라인을 확인하세요. 리소스 로케이터 # 가능하면 항상 리소스 로케이터 컴포넌트를 사용하세요. 이는 사용자에게 훨씬 나은 UX를 제공합니다. 리소스 로케이터 컴포넌트는 단일 항목을 선택해야 할 때 가장 유용합니다. 리소스 로케이터 컴포넌트의 기본 옵션은 (가능한 경우) From list 여야 합니다. 다른 노드와의 일관성 # UX 일관성 유지: n8n은 UX의 일관성을 유지하려고 노력합니다. 즉, 기존 UX 패턴, 특히 최신 신규 또는 개편된 노드에서 사용된 패턴을 따르는 것을 의미합니다. 유사한 노드 확인: 예를 들어, 데이터베이스 노드 작업 중이라면 Postgres 노드를 확인해 볼 가치가 있습니다. 정렬 옵션 # 사용자에게 정렬 옵션을 제공하여 특정 "Get Many" 작업을 개선할 수 있습니다. "Options" 컬렉션 아래에 전용 컬렉션으로 정렬을 추가하세요. Airtable Record:Search 의 예시를 참고하세요. 노드 기능 # 삭제 작업 출력 # 항목(레코드나 행 등)을 삭제할 때는 단일 객체를 담은 배열 {"deleted": true} 를 반환하세요. 이는 삭제가 성공했음을 사용자에게 확인시켜 주며, 이 항목이 다음 노드를 트리거하게 됩니다. 출력 필드 단순화 # 일반 노드: 'Simplify' 매개변수 # 엔드포인트가 10개 이상의 필드를 가진 데이터를 반환하는 경우, 최대 10개의 필드로 출력을 단순화한 버전을 반환하는 "Simplify" 불리언 매개변수를 추가하세요. n8n의 주요 문제점 중 하나는 데이터의 크기이며, Simplify 매개변수는 데이터 크기를 줄여 이 문제를 완화합니다. 단순화된 노드에서 출력할 가장 유용한 필드를 선택하고, 가장 많이 사용되는 필드가 위에 오도록 정렬하세요. Simplify 모드에서는 중첩된 필드를 평탄화하는 것이 좋은 경우가 많습니다. 표시 이름: Simp