はじめに
api-checkは純粋なフロントエンドAPIテストツールで、開発者のoctober-coder氏によってGitHub上でオープンソース化されており、特にoneapiやnewapiのようなOpenAIのプロキシAPIのAPIインターフェースのユーザビリティをテストするために主に使用されます。これは主にAPIインターフェースの使い勝手をテストするために使用され、特にoneapiやnewapiのようなOpenAIのプロキシAPIをサポートしています。すべての操作はブラウザで完了し、データのセキュリティを確保するためにバックエンドサーバに依存せず、ネットワークタイムアウトの問題を回避します。api-checkは操作が簡単で、中国語と英語のインターフェース、暗い色と明るい色のカラーモードをサポートしており、開発者がAPIのパフォーマンスを素早く検証するのに適しています。Vercel、Docker、Cloudflare経由でデプロイでき、高い柔軟性を備えています。
機能一覧
- oneapiやnewapiなどのOpenAIエージェントAPIの可用性をテストする。
- APIの応答時間、モデルの一貫性、システムのフィンガープリントを、はっきりと目に見える結果で表示します。
- クラウドストレージをサポートし、テスト設定をサーバーに保存して複数デバイスの同期が可能。
- ローカルストレージをサポートし、設定をブラウザにキャッシュして高速ロードを実現。
- 暗い色と明るい色のカラーモード切り替えが可能で、さまざまな使用環境に対応。
- 中国語と英語のインターフェイスをサポートし、さまざまなユーザーのニーズに応えます。
- 高速チャットテストを統合し、モデルの応答性を検証。
- GPT、Claude、およびMySQLのバッチテストをサポートしています。 ジェミニ キーの
- 検査結果を簡単に共有できるワンクリック・コピー機能を搭載。
- Vercel、Docker、Cloudflareのデプロイ方法をサポート。
ヘルプの使用
インストールと展開
api-checkは純粋にフロントエンドツールなので、オンラインバージョンを直接使うことも、自分でデプロイすることもできます。以下は、3つのデプロイ方法の詳細な手順です:
ヴェルセル配備
- GitHubリポジトリへのアクセス
見せるhttps://github.com/october-coder/api-check
をクリックし、プロジェクトページに移動する。 - ワンクリック配備
ページにある「Vercelでデプロイ」ボタンをクリックするか、直接https://vercel.com/new/clone?repository-url=https://github.com/october-coder/api-check
. - ログインして設定する
GitHubアカウントでVercelにログインし、環境変数のページにバックエンドのパスワードを追加します:- 鍵だ:
PASSWORD
価値がある:your_password
.
- 鍵だ:
- 配備完了
Deploy "をクリックすると、数分後にアドレスが生成されます。https://api-check-yourname.vercel.app
. - オプション
カスタムドメイン名をバインドする必要がある場合は、以下を参照してください。https://vercel.com/docs/concepts/projects/domains/add-a-domain
デフォルトのドメイン名が特定の地域で制限されるのを避けるためです。
Dockerのデプロイメント
- コマンド実行
ターミナルに以下のコマンドを入力し、ワンクリックでデプロイを行う:
docker run -d -p 13000:13000 -e PASSWORD=your_password -v your_path:/app/data --name api-check ghcr.io/rickcert/api-check:latest
- パラメータの説明
-p 13000:13000
ポートをローカル13000にマップする。-e PASSWORD
アクセスパスワードを設定します。-v your_path:/app/data
ローカル・ストレージ・パスを指定する。
- アクセスツール
配備が完了したら、ブラウザを開き、次のように入力します。http://localhost:13000
.
クラウドフレアの展開
- 参考チュートリアル
インタビューhttps://github.com/october-coder/api-check/blob/main/docs/cloudflare.md
手順に従ってください。 - バインディング・ドメイン名
安定したアクセスを確保するため、カスタムドメイン名をバインドすることを推奨する。
主な機能の使い方
APIの使いやすさをテストする
- api-checkのページを開く(オンライン版)
https://check.crond.dev
(または自己展開アドレス)。 - テストパラメータを入力する:
- APIキーキーを記入する。
sk-xxxx
. - URLAPI アドレスを入力します。
https://api.example.com
. - モデリング例:モデルの選択
gpt-4o-mini
. - タイムアウトリクエストタイムアウトを設定する。
10
秒。 - 同時実行同時リクエスト数を設定する。
2
.
- Test "ボタンをクリックし、結果を待つ。インターフェイスが表示されます:
- 応答時間(ミリ秒)。
- モデルの一貫性(期待に合っているか)。
- システムのフィンガープリンティング(APIの真正性の検証)。
設定の保存と読み込み
- クラウドストレージSave to Cloud "をクリックし、アカウントとパスワードを入力すると、設定がサーバーにアップロードされます。次回使用する際は、"Load from Cloud "をクリックしてロードしてください。
- ローカルストレージ: "Save Locally "をクリックして、設定をブラウザに保存します。次にページを開くと自動的に読み込まれます。
クイック・チャット・テスト
- インターフェイスで "クイックチャット "オプションを見つける。
- テスト問題を入力してください。例えば、「1+1はいくつになりますか?.
- Send(送信)」をクリックすると、モデルの返送結果が表示され、応答性と正確性が検証されます。
- 可
closeChat: true
この機能を無効にする(プロキシサイトに適しています)。
バッチテストキー
- Experimental Features "モジュールに行く。
- 複数のキーを入力(例:GPT Refresh トークン もしかしたら クロード セッションの鍵
- バッチテスト」をクリックすると、ツールは結果を一つずつ検証し、表示します。
高度な認証機能
- オフィシャル・エージェントの検証複数の同一のリクエストを送信し、一貫性を分析し、システムのフィンガープリントを表示します。
- 温度検証温度パラメーターを
0.01
モデルのランダム性と安定性をテストする。 - 関数呼び出しの検証モデルが関数コールをサポートし、正しい結果を返すかどうかをテストする。
作業工程例
OpenAIのエージェントAPIをテストしたいとします:
- 見せる
https://check.crond.dev
. - インプット:
- APIキー
sk-test123
. - URL:
https://api.test.com
. - モデル
gpt-4o
. - タイムアウト:
10
秒、同時:2
.
- Test "をクリックすると、応答時間が300msとなり、モデルの整合性は合格となる。
- クラウドに保存」をクリックし、アカウント番号を入力して保存します。
- 次に開くときは、"Load from Cloud "をクリックして自動ロードを設定する。
- クイックチャット」で「今日の天気は?返された結果を見る。
このプロセスはシンプルでわかりやすく、すぐに始めるのに適している。
アプリケーションシナリオ
- APIパフォーマンス検証
開発者はAPIが安定していることを確認する必要がある。api-checkは応答時間と一貫性を表示し、問題を特定するのに役立つ。 - マルチデバイス設定の同期
チームはさまざまなデバイスでAPIをテストします。クラウドストレージで設定を保存し、メンバーはいつでもロードできるため、効率が向上します。 - 行動モデルを学ぶ
初心者はAPIが返す結果のパターンを理解したい。クイックチャットや温度検証を通してモデルのパフォーマンスを観察したい。
品質保証
- api-checkはバックエンドのサポートを必要としますか?
必要ありません。すべてフロントエンドで実行され、データはサードパーティのサーバーにアップロードされません。 - 対応機種は?
主にOpenAIエージェントAPIをサポートするモデル、例えばgpt-4o-mini
また、同様の形式の他のAPIとも互換性がある。 - テストレポートはどのように見ることができますか?
テストが完了すると、インターフェースは応答時間、一貫性、フィンガープリントなどの情報を含むレポートを生成する。