아름다운 API 키 만들기

요약: 개발자 환경을 개선하기 위해 AgentStation은 UUID를 아름답고 읽기 쉬운 API 키로 인코딩하는 uuidkey 패키지를 만들었습니다. 이 패키지는 UUIDv7을 지원하며 데이터베이스 정렬 및 인덱싱을 위한 키를 디코딩할 수 있습니다.

질문:

API 키는 사용자가 AgentStation 제품과 처음 상호 작용할 때 중요한 부분입니다. 우리는 열쇠가 아름답고 사용하기 쉽기를 원하지만 업계에는 표준이 부족한 것 같습니다. 개발자 중심의 스타트업으로서 우리는 이상적인 솔루션을 찾기 위해 시간과 노력을 투자합니다.

대부분의 API 키가 형편없습니다:

API 키에 대한 요구 사항은 다음과 같습니다.

• 안전
• 전 세계적으로 고유함
• 정렬 가능
• Postgres의 뛰어난 성능
• 아름다운 외모

그러나 대부분의 API 키는 미학적 측면이 부족하고 읽기, 정렬, 식별하기 어려운 일관되지 않은 형식의 무작위 문자인 경우가 많습니다. 우리는 API 키가 인생의 좋은 것들처럼 미학적으로 보기 좋고 대칭적이기를 원합니다.

거부된 ID:

너무 무작위적이고, 추측하기 쉽고, 보기에도 흉하고...모두 불만족스럽습니다.

• 정수 및 BigInt: 읽기 쉽고 정렬하기 쉽습니다. 그러나 키 개수가 노출되고 추측하기 쉬우며 보안이 부족합니다.
• NanoID: 공개 식별자에 이상적인 완전히 임의의 사용자 정의 가능한 ID를 제공합니다. 그러나 정렬 및 디버깅을 위한 타임스탬프 정보가 부족합니다.
• UUID: 업계 표준, 고려해 볼 만한 두 가지 버전:
  • UUIDv4: 단순하고 효과적인 임의의 문자입니다.
  • UUIDv7: 간편한 디버깅 및 데이터베이스 쿼리 정렬을 위한 타임스탬프를 포함합니다.
• ULID: 에는 타임스탬프가 포함되어 있으며 가독성을 높이기 위해 Base32를 사용하여 인코딩됩니다. 그러나 우리는 UUID 기본 Postgres 지원을 선호하며 그 미학은 여전히 ​​부족합니다.

저희 솔루션:

기존 솔루션의 미적 측면(대칭성)이 부족하여 다음과 같은 고유한 접근 방식을 만들었습니다.

1. 타임스탬프 정보를 활용하여 UUIDv7을 기본 ID로 사용합니다.
2. 가독성을 높이려면 Crockford Base32 인코딩을 사용하세요.
3. 시각적 효과를 높이려면 아름다운 대시를 추가하세요.

결과:

<code>key, _ := uuidkey.Encode("d1756360-5da0-40df-9926-a76abff5601d")
fmt.Println(key) // Output: 38QARV0-1ET0G6Z-2CJD9VA-2ZZAR0X</code>

우리의 키:

• 31자(대시 없이 28자), UUID의 36자보다 짧습니다.
• 7개의 대문자와 숫자로 구성된 4세트를 포함하고 "뭉툭한" 미학과 가독성을 갖춘 가독성이 높은 단락입니다.
• 디코딩된 UUID로 저장 시 시간순으로 정렬 가능합니다.
• 사용자에게 표시되는 키의 타임스탬프는 난독화되어 있습니다(그러나 기술에 정통한 사용자는 여전히 디코딩할 수 있습니다). 키의 타임스탬프 메타데이터는 추가 보너스라고 생각하며 UUIDv4를 사용하도록 선택할 수도 있습니다!

UUIDv7을 선택하는 이유는 무엇입니까?

타임스탬프의 장점 외에도 UUIDv7은 Postgres v18에서 기본 지원을 받게 됩니다. 현재 확장 기능을 사용하여 서버 측에서 UUIDv7을 생성하는 것이 가능하지만 기본 Postgres 지원은 확실히 더 나은 성능을 발휘하고 uuidkey.Encode()과 잘 작동합니다.

현재 구현 시 애플리케이션 계층에서 키를 생성하고 정렬 및 인덱싱을 위해 이를 UUID로 저장합니다. Postgres v18이 출시되면 Postgres 빌드로 전환하여 애플리케이션 계층의 부하를 줄이고 더 나은 성능을 달성할 것입니다.

Crockford Base32를 선택하는 이유는 무엇인가요?

Crockford Base32 인코딩을 선택한 이유는 다음과 같습니다.

• 가독성을 높이기 위해 대문자와 숫자만 사용하세요.
• 키 길이를 약 1/5로 줄입니다.
• 매핑은 효율적이고 예측 가능합니다.

대시를 사용하는 이유는 무엇인가요?

대시 키는 '뭉툭'하고 대칭적입니다. 개별 문자를 회색으로 표시하면 거의 바코드처럼 보입니다. 이를 통해 키의 일부를 빠르게 읽고 식별하는 것이 쉬워진다고 생각합니다.

대시는 편리한 두 번 클릭 복사 기능을 제거하지만 가독성을 고려하면 가치 있는 절충안이라고 생각합니다. 우리는 사용자가 모든 곳에 복사하여 붙여넣는 것을 원하지 않으며 실제로 조심스럽게 다루기를 원합니다. 이상적으로는 사용자가 대시보드에서 키를 생성할 때 키를 한 번만 복사하므로 이 문제를 해결하기 위해 UI에 복사 버튼을 추가했습니다.

uuidkey 패키지:

저희는 github.com/agentstation/uuidkey에서 이러한 디자인 선택 사항을 오픈소스로 공개했습니다. 우리의 미학, 추론, 대칭성에 동의하고 자신만의 아름다운 API 키를 갖고 싶다면 자유롭게 우리의 오픈 소스 프로젝트를 사용해 보세요.

uuidkey 패키지의 핵심은 Base32-Crockford 코덱을 통해 UUID를 읽을 수 있는 키 형식으로 인코딩한 후 다시 UUID로 디코딩하는 것입니다.

인코딩:

코드 조각은 원본 텍스트에 제공되었으며 여기서는 반복되지 않습니다.

디코딩:

코드 조각은 원본 텍스트에 제공되었으며 여기서는 반복되지 않습니다.

이 패키지는 공식 UUID 사양(RFC 4122)을 따르는 모든 UUID에서 작동하도록 설계되었지만 가장 널리 사용되는 두 가지 UUID Go 생성기와의 호환성을 특별히 테스트하고 유지합니다.

• 고퍼스
• 구글

설치가 쉽습니다.

<code>key, _ := uuidkey.Encode("d1756360-5da0-40df-9926-a76abff5601d")
fmt.Println(key) // Output: 38QARV0-1ET0G6Z-2CJD9VA-2ZZAR0X</code>

기본 사용법:

<code>go get github.com/agentstation/uuidkey</code>

우리는 간접비를 최소화하기 위해 노력합니다:

성능 벤치마크 테스트 데이터는 원문에 제공되었으며 여기서는 반복하지 않습니다.

uuidkey에 기여:

우리는 uuidkey을 프로덕션에서 사용하기 때문에 신뢰할 수 있는 오픈 소스 도구로 유지하기 위해 최선을 다하고 있습니다. 기여를 환영합니다!

이 내용이 유용하다고 생각하거나 개선을 위한 제안 사항이 있으면 GitHub 문제 또는 Discord 커뮤니티에서 여러분의 의견을 듣고 싶습니다.

선진기술과 거인의 어깨:

프로젝트를 출시한 후 유사한 구현을 갖춘 몇 가지 프로젝트를 찾았지만 여전히 Go를 사용한 UUID 인코딩 및 디코딩 기준을 충족하지 못했습니다.

• uuidapikey - Go이지만 UUID 입력 인코딩 또는 디코딩을 지원하지 않습니다.
• based_uuid - Ruby이지만 공개 ID용입니다.

요약:

AgentStation에서는 AI 에이전트가 자체 가상 워크스테이션을 보유하여 브라우저를 실행하고, 회의에 참석하고, 코드를 실행할 수 있는 플랫폼을 구축하고 있습니다. 수천 개의 워크스테이션으로 확장함에 따라 정렬 가능한 고성능 키를 보유하는 것이 실용적인 인프라입니다.

그러나 우리는 개발자들도 우리만큼 API 키에서도 대칭의 아름다움을 높이 평가한다고 믿습니다.

실용성과 아름다움을 모두 갖춘uuidkey을 만나보시기 바랍니다.

각주는 원문에 나와 있으므로 여기서는 반복하지 않습니다.

위 내용은 아름다운 API 키 만들기의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!