Servemyapi

🚀 为我的API服务

macOS Keychainを通じて、プロジェクト間でAPIキーを安全に保存し、アクセスするためのツールです。

🚀 クイックスタート

ServeMyAPI は、開発者がmacOSのキーチェーンを通じてAPIキーを安全に管理およびアクセスするのを支援するツールです。これにより、開発者は機密情報をシステムレベルの安全な施設に保存でき、コードリポジトリにハードコードしたり、設定ファイルに平文で保存したりする必要がなくなります。

✨ 主な機能

安全な保存とアクセス

• 暗号化保存：すべてのAPIキーは、業界標準の暗号化プロトコルを通じてmacOSキーチェーンに保存されます。
• 権限管理：保存されたキーには、認証されたユーザーのみがアクセスでき、不正な使用を防ぎます。

便利なCLIツール

ServeMyAPI は使いやすいコマンドラインインターフェース（CLI）を提供し、以下の操作をサポートしています。

1. APIキーの保存

serve-my-api store --name <KEY_NAME> --key <API_KEY>

• パラメータ：
  • --name：後でアクセスするためのキーの一意の識別子。
  • --key：保存する実際のAPIキー。

2. APIキーの取得

serve-my-api get --name <KEY_NAME>

• パラメータ：
  • --name：取得するキーの識別子。

3. APIキーの削除

serve-my-api delete --name <KEY_NAME>

• パラメータ：
  • --name：削除するキーの識別子。

4. 保存されたすべてのキーの一覧表示

serve-my-api list

📦 インストール

グローバルインストール（推奨）

npm install -g serve-my-api

ローカル開発環境へのインストール

特定のプロジェクトで使用する場合は、開発依存としてインストールできます。

npm install --save-dev serve-my-api

💻 使用例

基本的な使用法

1. キーの保存

serve-my-api store --name openai-key --key sk-your-key-here

2. キーの取得

serve-my-api get --name openai-key  # 戻り値：sk-your-key-here

3. キーの削除

serve-my-api delete --name openai-key

4. すべてのキーの一覧表示

serve-my-api list  # 出力例：
# [
#   { name: 'openai-key', exists: true },
#   { name: 'stripe-key', exists: true }
# ]

高度な使用法

1. CI/CDパイプラインへの統合

ビルドプロセスで ServeMyAPI を使用して、APIキーを安全に注入できます。

serve-my-api get --name openai-key | xargs npm run-script build

2. キーの自動読み込み

スケルトンツールやフレームワークを構成することで、ServeMyAPI を自動的にサポートするようにできます。例えば、package.json に以下を追加します。

{
  "scripts": {
    "start": "serve-my-api get --name openai-key | node server.js"
  }
}

📚 ドキュメント

なぜ「为我的API服务」を選ぶのか？

1. 従来の .env ファイルのセキュリティ上の問題を解決

• バージョン管理へのcredentialsのコミットを防止
  開発者は、機密情報を含む .env ファイルを誤ってコードリポジトリにコミットすることがよくあり、セキュリティホールにつながります。ServeMyAPI は、キーをファイルシステムに保存しないため、この問題を回避します。

• プロジェクト間の一貫性
  各プロジェクトには独自の .env ファイルがあり、これによりクレデンシャルが分散し、管理が混乱します。ServeMyAPI を使用することで、すべてのプロジェクトが同じ安全な保存場所を共有してAPIキーを管理できます。

2. 強化されたセキュリティ

• システムレベルの暗号化
  macOSキーチェーンは、検証済みの暗号化プロトコルを使用してキーを保護し、デバイスが物理的にアクセスされた場合でも、不正なユーザーが機密情報を復号化できないようにします。

• 認証要求
  キーチェーン内のデータにアクセスするには、ユーザーの明示的な承認が必要です。これは、開発環境において追加のセキュリティ層を提供します。

安全注意事項

• 暗号化保存：すべてのキーはmacOSキーチェーンを通じて暗号化され、データの安全性が確保されます。
• アクセス制御：認証されたユーザーのみがキーチェーン内の内容にアクセスできます。
• 平文保存なし：ServeMyAPI は、キーを平文でファイルシステムに保存することはありません。

よくある質問

Q: キーの安全性をどのように確保できますか？

A: ServeMyAPI は、macOSのネイティブキーチェーンサービスを使用しており、これは厳密にテストされ、検証された安全なメカニズムです。システムパスワードを適切に管理すれば、データの安全性を保証できます。

Q: どのプラットフォームをサポートしていますか？

A: 現在、ServeMyAPI はmacOSシステムのみをサポートしています。WindowsとLinuxのサポートは開発中です。

Q: 本番環境で使用できますか？

A: ServeMyAPI を本番環境で直接使用することはお勧めしません。これは、ビルドプロセスがローカルのクレデンシャルに依存することになるためです。敏感な情報管理をより専門的なシークレット管理システム（例：HashiCorp Vault）に統合することをお勧めします。

開発と貢献

プロジェクト開発に参加したり、機能要求を提出したりする場合は、GitHubリポジトリをご覧ください。

📄 ライセンス

ServeMyAPI はMITライセンスのオープンソースプロジェクトです。詳細なライセンス情報は、LICENSE ファイルを参照してください。