概要: 開発者のエクスペリエンスを向上させるために、AgentStation は、UUID を美しく読みやすい API キーにエンコードするための uuidkey パッケージを作成しました。このパッケージは UUIDv7 をサポートしており、データベースの並べ替えとインデックス作成のためのキーをデコードできます。

質(zhì)問:

API キーは、ユーザーが AgentStation 製品と最初にやり取りする際の重要な部分です。キーは美しく、使いやすいものであることが望まれますが、業(yè)界には標(biāo)準(zhǔn)が不足しているようです。開発者中心のスタートアップとして、私たちは理想的なソリューションを見つけるために時(shí)間と労力を投資しています。

ほとんどの API キーは最悪です:

API キーには次の要件があります:

• 安全性
• 世界的にユニーク
• 並べ替え可能
• Postgres での優(yōu)れたパフォーマンス
• 美しい外観

しかし、ほとんどの API キーは美観に欠けており、一貫性のないランダムな文字であることが多く、読み取り、並べ替え、識(shí)別が困難です。 私たちは、API キーが、人生の良いもののように、見た目が美しく、対稱的であることを望んでいます。

拒否された ID:

ランダムすぎる、推測(cè)しやすい、見た目が醜い...すべてが満足できません。

• 整數(shù)と BigInt: 読みやすく、並べ替えも簡(jiǎn)単です。しかし、キーの數(shù)が公開され、推測(cè)が容易で、セキュリティが不十分です。
• NanoID: 完全にランダムなカスタマイズ可能な ID を提供し、公開識(shí)別子に最適です。ただし、並べ替えやデバッグのためのタイムスタンプ情報(bào)が不足しています。
• UUID: 業(yè)界標(biāo)準(zhǔn)。検討に値する 2 つのバージョンがあります:
  • UUIDv4: 純粋にランダムな文字、シンプルかつ効果的。
  • UUIDv7: デバッグとデータベース クエリの並べ替えを容易にするタイムスタンプが含まれています。
• ULID: にはタイムスタンプが含まれており、可読性を高めるために Base32 を使用してエンコードされます。しかし、私たちは UUID ネイティブ Postgres サポートを好みますが、その美しさはまだ不十分です。

私たちのソリューション:

既存のソリューションには美學(xué) (対稱性) が欠けているため、獨(dú)自のアプローチを作成しました。

1. ベース ID として UUIDv7 を使用し、タイムスタンプ情報(bào)を利用します。
2. Crockford Base32 エンコードを使用して可読性を向上させます。
3. 美しいダッシュを追加して視覚効果を高めます。

結(jié)果:

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

私たちのキー:

• 31 文字 (ダッシュなしで 28 文字)、UUID の 36 文字より短い。
• 7 つの大文字と數(shù)字の 4 セットを含む可読性の高い段落?！弗芝恁氓癄睢工蚊坤筏丹瓤烧i性を備えています。
• デコードされた UUID として保存すると、時(shí)系列に並べ替えることができます。
• ユーザーに表示されるキーのタイムスタンプは難読化されています (ただし、技術(shù)に精通したユーザーはデコードできます)。キー內(nèi)のタイムスタンプ メタデータは追加のボーナスであると考えており、UUIDv4 の使用を選択することもできます。

UUIDv7 を選択する理由?

タイムスタンプの利點(diǎn)に加えて、UUIDv7 は Postgres v18 でネイティブ サポートを受ける予定です?，F(xiàn)在、拡張機(jī)能を使用してサーバー側(cè)で UUIDv7 を生成することは可能ですが、ネイティブの Postgres サポートは間違いなくパフォーマンスが向上し、uuidkey.Encode() とうまく連攜するでしょう。

私たちの実裝では現(xiàn)在、アプリケーション層でキーを生成し、並べ替えとインデックス付けのためにそれらを UUID として保存しています。 Postgres v18 がリリースされたら、アプリケーション層の負(fù)荷を軽減し、より良いパフォーマンスを達(dá)成するために Postgres ビルドに切り替える予定です。

Crockford Base32 を選ぶ理由?

Crockford Base32 エンコードを選択した理由は次のとおりです。

• 読みやすくするために、大文字と數(shù)字のみを使用してください。
• キーの長(zhǎng)さを約 1/5 に短縮します。
• マッピングは効率的で予測(cè)可能です。

ダッシュを使用する理由

ダッシュ キーは「ブロック狀」で対稱的です。個(gè)々の文字をグレーアウトすると、まるでバーコードのように見えます。これにより、キーの一部をすばやく読み取って識(shí)別することが容易になると考えられます。

ダッシュにより、便利なダブルクリックのコピー機(jī)能が削除されますが、これは読みやすさとのトレードオフとして価値があると考えています。私たちは、ユーザーがそれらをどこにでもコピーして貼り付けることを望んでいません。実際、私たちはそれらを慎重に扱ってほしいと考えています。理想的には、ユーザーはダッシュボードでキーを生成するときにキーを 1 回だけコピーする必要があるため、この問題を解決するために UI にコピー ボタンを追加しました。

uuidkey パッケージ:

これらの設(shè)計(jì)の選択肢は、github.com/agentstation/uuidkey でオープンソース化されています。私たちの美學(xué)、推論、対稱性に同意し、獨(dú)自の美しい API キーを取得したい場(chǎng)合は、遠(yuǎn)慮なく私たちのオープンソース プロジェクトを試してみてください。

uuidkey パッケージの中核は、Base32-Crockford コーデックを介して UUID を読み取り可能なキー形式にエンコードし、それをデコードして UUID に戻すことです。

エンコーディング:

コード スニペットは原文に記載されているため、ここでは繰り返しません。

デコード:

コード スニペットは原文に記載されているため、ここでは繰り返しません。

このパッケージは、公式 UUID 仕様 (RFC 4122) に従う任意の UUID で動(dòng)作するように設(shè)計(jì)されていますが、特に最も人気のある 2 つの UUID Go ジェネレーターとの互換性をテストし、維持しています。

• ゴファー
• Google

インストールは簡(jiǎn)単です:

<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 に貢獻(xiàn)します:

私たちは uuidkey を?qū)g稼働環(huán)境で使用しているため、信頼できるオープンソース ツールとして維持することに盡力しています - 貢獻(xiàn)は歓迎です!

これが役立つと思われる場(chǎng)合、または改善のための提案がある場(chǎng)合は、GitHub の問題または Discord コミュニティでご意見をお待ちしています。

先行技術(shù)と巨人の肩:

プロジェクトをリリースした後、同様の実裝を持つプロジェクトがいくつか見つかりましたが、それでも Go を使用した UUID のエンコードとデコードの基準(zhǔn)を満たしていませんでした。

• uuidapikey - Go ですが、UUID 入力のエンコードまたはデコードはサポートしていません。
• based_uuid - Ruby、ただしパブリック ID 用。

概要:

AgentStation では、AI エージェントが獨(dú)自の仮想ワークステーションを使用してブラウザを?qū)g行し、會(huì)議に出席し、コードを?qū)g行できるようにするプラットフォームを構(gòu)築しています。數(shù)千のワークステーションに拡張する場(chǎng)合、ソート可能で高性能なキーを持つことが実用的なインフラストラクチャとなります。

しかし、開発者も私たちと同じように、API キーであっても対稱性の美しさを高く評(píng)価していると私たちは信じています。

実用的かつ美しい uuidkey を見つけていただければ幸いです。

腳注は原文に記載されているため、ここでは繰り返しません。

以上が美しい API キーの作成の詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語(yǔ) Web サイトの他の関連記事を參照してください。