Introdução geral
O api-check é uma ferramenta de teste de API de front-end puro, de código aberto pelo desenvolvedor october-coder no GitHub, usada principalmente para testar a usabilidade das interfaces de API, especialmente para APIs proxy OpenAI, como oneapi e newapi. É usado principalmente para testar a usabilidade das interfaces de API, especialmente o suporte para APIs proxy OpenAI, como oneapi e newapi. Todas as operações são concluídas no navegador, não dependem dos servidores back-end, para garantir a segurança dos dados e evitar problemas de tempo limite da rede. A ferramenta fornece dados detalhados, como tempo de resposta e consistência do modelo, e também suporta configurações de teste de armazenamento local e em nuvem. O api-check é fácil de operar, suporta interfaces em chinês e inglês e modos de cores escuras e claras, e é adequado para que os desenvolvedores verifiquem rapidamente o desempenho da API. Ele pode ser implantado por meio do Vercel, Docker ou Cloudflare para maior flexibilidade.
Lista de funções
- Teste a disponibilidade das APIs do agente OpenAI, como oneapi e newapi.
- Exibe os tempos de resposta da API, a consistência do modelo e as impressões digitais do sistema com resultados claramente visíveis.
- Suporta armazenamento em nuvem para salvar as configurações de teste no servidor para sincronização com vários dispositivos.
- Oferece suporte ao armazenamento local, armazenando em cache as configurações no navegador para um carregamento rápido.
- Oferece alternância de modo de cores escuras e claras, adaptando-se a diferentes ambientes de uso.
- Oferece suporte a interfaces em chinês e inglês para atender a diferentes necessidades dos usuários.
- Integrar testes rápidos de bate-papo para validar a capacidade de resposta do modelo.
- Oferece suporte a testes em lote de GPT, Claude e Gêmeos da chave.
- Oferece a função de cópia com um clique para facilitar o compartilhamento dos resultados dos testes.
- Oferece suporte aos métodos de implantação Vercel, Docker e Cloudflare.
Usando a Ajuda
Instalação e implementação
O api-check é puramente uma ferramenta de front-end, você pode usar a versão on-line diretamente ou implantá-la você mesmo. Abaixo estão as etapas detalhadas para os três métodos de implementação:
Implantação da Vercel
- Acesso aos repositórios do GitHub
show (um ingresso)https://github.com/october-coder/api-check
acesse a página do projeto. - Implementação em um clique
Clique no botão "Deploy with Vercel" na página ou vá diretamente para a seçãohttps://vercel.com/new/clone?repository-url=https://github.com/october-coder/api-check
. - Faça login e configure
Faça login no Vercel com sua conta do GitHub e adicione a senha de back-end à página de variáveis de ambiente, por exemplo:- Chave:
PASSWORD
Valor:your_password
.
- Chave:
- Implementação concluída
Clique em "Deploy" e, após alguns minutos, será gerado um endereço, por exemplohttps://api-check-yourname.vercel.app
. - Operações opcionais
Se você precisar vincular um nome de domínio personalizado, consultehttps://vercel.com/docs/concepts/projects/domains/add-a-domain
para evitar que o nome de domínio padrão seja restrito em determinadas regiões.
Implementação do Docker
- Executar comando
Digite o seguinte comando no terminal para a implementação com um clique:
docker run -d -p 13000:13000 -e PASSWORD=your_password -v your_path:/app/data --name api-check ghcr.io/rickcert/api-check:latest
- Descrição do parâmetro
-p 13000:13000
Porta de mapeamento para o local 13000.-e PASSWORD
Senha de acesso: Defina a senha de acesso.-v your_path:/app/data
Especifica o caminho do armazenamento local.
- ferramenta de acesso
Quando a implantação estiver concluída, abra seu navegador e digitehttp://localhost:13000
.
Implantação da Cloudflare
- Tutorial de referência
entrevistashttps://github.com/october-coder/api-check/blob/main/docs/cloudflare.md
Siga as etapas. - Nome de domínio vinculado
Recomenda-se associar um nome de domínio personalizado para garantir um acesso estável.
Como usar os principais recursos
Teste de usabilidade da API
- Abra a página api-check (versão on-line)
https://check.crond.dev
(ou endereço de autoimplantação). - Insira os parâmetros de teste:
- Chave da APIPreencha a chave, por exemplo.
sk-xxxx
. - URLDigite o endereço da API, por exemplo.
https://api.example.com
. - modelagemSeleção de modelos, por exemplo
gpt-4o-mini
. - tempo limiteTempo limite da solicitação: defina o tempo limite da solicitação, por exemplo.
10
Segundos. - concorrênciaNúmero de solicitações simultâneas: defina o número de solicitações simultâneas, por exemplo
2
.
- Clique no botão "Test" e aguarde o resultado. A interface será exibida:
- Tempo de resposta em milissegundos.
- Consistência do modelo (corresponde às expectativas).
- Impressão digital do sistema (verificação da autenticidade da API).
Salvando e carregando configurações
- armazenamento em nuvemClique em "Save to Cloud" (Salvar na nuvem), digite sua conta e senha, e a configuração será carregada no servidor. Na próxima vez que você a usar, clique em "Load from Cloud" (Carregar da nuvem) para carregá-la.
- armazenamento localClique em "Save Locally" (Salvar localmente) para salvar a configuração em seu navegador. Na próxima vez que você abrir a página, ela será carregada automaticamente.
Teste de bate-papo rápido
- Localize a opção "Quick Chat" na interface.
- Digite uma pergunta de teste, por exemplo, "How many does 1+1 equal?" (Quantos são iguais a 1+1?). .
- Clique em Send (Enviar) para ver os resultados do retorno do modelo e verificar a capacidade de resposta e a precisão.
- aceitável
closeChat: true
Desative esse recurso (adequado para sites proxy).
Chave de teste de lote
- Vá para o módulo "Recursos experimentais".
- Digite várias chaves, por exemplo, GPT Refresh Tokens talvez Claude Chaves da sessão.
- Clique em "Batch Test" (Teste em lote) e a ferramenta verificará e exibirá os resultados um a um.
Funções avançadas de autenticação
- Verificação oficial de agenteSolicitações idênticas: envia várias solicitações idênticas, analisa a consistência e exibe as impressões digitais do sistema.
- Verificação de temperaturaAjuste o parâmetro de temperatura para
0.01
e testar a aleatoriedade e a estabilidade do modelo. - Validação de chamada de funçãoTeste se o modelo suporta chamadas de função e retorna o resultado correto.
Exemplo de processo de operação
Suponha que você queira testar uma API de agente da OpenAI:
- show (um ingresso)
https://check.crond.dev
. - Entrada:
- Chave de API:
sk-test123
. - URL:
https://api.test.com
. - Modelos:
gpt-4o
. - Tempo limite:
10
Segundos, concorrente:2
.
- Clique em "Test", o resultado mostra um tempo de resposta de 300 ms e a consistência do modelo é aprovada.
- Clique em "Save to Cloud" (Salvar na nuvem) e digite o número de sua conta para salvar.
- Na próxima vez que você abri-lo, clique em "Load from Cloud" (Carregar da nuvem) para configurar o carregamento automático.
- Vá para "Quick Chat" e digite "What's the weather like today?" (Como está o tempo hoje?) e veja os resultados retornados.
Esse processo é simples e direto e é bom para começar rapidamente.
cenário do aplicativo
- Validação de desempenho da API
Os desenvolvedores precisam verificar se a API é estável. O api-check mostra os tempos de resposta e a consistência para ajudar a identificar problemas. - Sincronização da configuração de vários dispositivos
As equipes testam APIs em diferentes dispositivos e salvam as configurações com armazenamento em nuvem que os membros podem carregar a qualquer momento, aumentando a eficiência. - Aprendendo a modelar o comportamento
Os novatos querem entender os padrões dos resultados retornados pela API. Observar o desempenho do modelo por meio de bate-papos rápidos e validação de temperatura.
QA
- O api-check requer suporte de back-end?
Não é necessário. Ele é executado inteiramente no front-end e os dados não são carregados em servidores de terceiros. - Quais são os modelos suportados?
Modelos que suportam principalmente a API do agente OpenAI, como ogpt-4o-mini
Ele também é compatível com outras APIs em formatos semelhantes. - Como posso visualizar o relatório de teste?
Após a conclusão do teste, a interface gera um relatório com informações como tempo de resposta, consistência e impressão digital.