Introdução às ferramentas de gerenciamento de API - explicação detalhada do uso do Apifox

Índice

Como fazer o gerenciamento de API normalmente

Iteração ágil e colaboração em equipe, o modo de trabalho de separar o front-end e o back-end é quase o modo de trabalho normal de todas as empresas de Internet .

Existem muitas vantagens no desenvolvimento separado de front-end e back-end, uma delas é que ele só precisa fornecer uma interface de API unificada, que pode ser usada por vários clientes, como web , iOS, Android , etc., melhorando muito a eficiência .

No entanto, nascer na agilidade, morrer na iteração e ficar preso no trabalho em equipe costuma ser uma grande desvantagem desse modelo de desenvolvimento de software. À medida que o projeto continua avançando e mudando, o projeto está ficando cada vez maior e o custo de manutenção está ficando cada vez mais alto.

Como algumas empresas adotam formulários wiki, html e openapi para gerenciamento de documentos de interface, a iteração da versão é rápida, a interface é frequentemente alterada e a atualização e manutenção de documentos entre os membros geralmente não conseguem acompanhar.

Na fase posterior do gerenciamento da API, há um desperdício considerável e invisível de "recursos humanos":

1) Os documentos estão desatualizados e indisponíveis. Os recém-chegados dependem de "pessoas mais velhas" para começar e se familiarizar com o projeto, resultando em um duplo desperdício de mão-de-obra. O progresso do próprio trabalho dos membros da equipe é prejudicado e o progresso da capacidade dos recém-chegados de concluir tarefas é lento.
2) A interface é modificada devido a problemas de design inicial/expansão de função/mudanças de requisitos, mas muitas vezes é difícil sincronizar com links downstream como front-end e testar no tempo após a modificação

Grupo de troca de aprendizado de teste automatizado Python: um conjunto completo de materiais de aprendizado de resumo de entrevista de teste automatizado para obter Clique no link para entrar no bate-papo do grupo [troca de teste automatizado de python]: http://qm.qq.com/cgi-bin/qm/ qr?_wv=1027&k=DhOSZDNS -qzT5QKbFQMsfJ7DsrFfKpOF&authKey=eBt%2BF%2FBK81lVLcsLKaFqnvDAVA8IdNsGC7J0YV73w8V%2FJpdbby66r7vJ1rsPIifg&noverify=0&group_code= 198408628

Estas situações tornar-se-ão mais graves nas fases posteriores de desenvolvimento do projeto. Como resultado, muitos funcionários de P&D sempre reclamam: escrever código não é cansativo, mas comunicação e encaixe são cansativos; o trabalho não é difícil, mas a vida é difícil.

Como fazer o gerenciamento de API normalmente

Para resolver os problemas dos desenvolvedores, precisamos resolver vários pontos problemáticos no gerenciamento de API. Em outras palavras, uma ferramenta de gerenciamento de API perfeita deve atender às seguintes características:

**No estágio de design de interface, pode padronizar o design de interface do pessoal de P&D

No estágio de depuração da interface , ele fornece uma variedade de funções para depurar totalmente e simular altamente a situação real de trabalho

No processo de manutenção da interface , o custo de manutenção é baixo e todas as alterações podem ser atualizadas para os colegas da equipe no link de trabalho a jusante a tempo

Serviço completo, uma ferramenta pode concluir o processo de design, depuração, manutenção e teste de interface, sem importação e exportação repetidas, e alternar entre vários softwares para melhorar a eficiência. **

solução final

O autor pesquisou por muito tempo na Internet e encontrou uma solução de software que quase atende aos requisitos acima - Apifox. As principais características deste software:

A interface de design de interface visual suporta os protocolos https e https e segue as especificações openApi e Json Schema. Todos os parâmetros de solicitação http e descrições de interface podem ser preenchidos diretamente. Suporta a construção de modelos de dados que podem ser reutilizados por vários parâmetros de solicitação.

Comparável à função de depuração da interface do carteiro , além disso, ele também oferece suporte a "configuração zero" simulando dados de negócios altamente simulados e suporta bancos de dados de leitura

O sistema gera automaticamente o código De acordo com a definição da interface e do modelo de dados, o sistema gera automaticamente o código de solicitação da interface, o código comercial front-end e o código comercial back-end

Atualização em tempo real dos dados alterados na nuvem para cada membro da equipe, evitando duplicação e retrabalho causados por inconsistência de dados; atualização de código e atualização de documento são todas concluídas no mesmo software, reduzindo a carga de trabalho de manutenção

O gerenciamento de projetos atribui diferentes permissões de execução a diferentes funções do projeto para proteger efetivamente a segurança dos dados do projeto; suporte a projetos antigos no formato openapi e postman para importar apifox , realizar migração indolor do projeto e suporte à exportação de dados da interface em vários formatos, como formato html e openapi.

A seguir, o autor apresentará algumas funções em detalhes.

design de interface

A interface é visualizada e as informações da interface podem ser editadas e gerenciadas. Os métodos convencionais de solicitação de interface, como get e post, podem ser selecionados diretamente na caixa suspensa; os parâmetros de consulta, corpo e cabeçalho podem ser preenchidos diretamente e o parâmetros de retorno suportam importações de formato JSON e XML e podem executar diretamente o teste de calibração de formato. A parte da descrição da interface suporta texto no formato Markdown.

2. Depuração de interface
Existem dois modos de depuração de interface, um é depuração rápida sem criar um projeto e verifica diretamente a solicitação de interface e os parâmetros de retorno, o outro é depuração de uma única interface no projeto, a função desta parte é basicamente equivalente ao carteiro. Uma variedade de pré e pós-operações podem ser adicionadas:

Verifique a resposta retornada e verifique se o status retornado e a estrutura de dados atendem às expectativas.

3. Manutenção da interface Ao alterar a interface, modifique e gere novo código diretamente no apifox, e a documentação é armazenada no mesmo local, tornando muito conveniente modificar a descrição da documentação. Depois que a interface é alterada, os membros colaboradores podem sincronizar as alterações na nuvem no tempo.

4. O gerenciamento de projetos oferece suporte à importação e exportação de dados e gera códigos de interface automaticamente

Defina diferentes permissões de dados para membros de diferentes funções. Por exemplo, o P&D de back-end pode modificar os dados da interface, enquanto o front-end e os membros de teste têm apenas permissões somente leitura e aqueles fora do projeto têm apenas permissões de visitante para visualizar as informações da interface, mas não os tipos de dados.

Diferentes servidores podem ser configurados para desenvolvimento e depuração, verificação de teste e uso online:

também

O Apifox não é apenas uma ferramenta de gerenciamento de API para desenvolvedores, mas também fornece aos testadores uma série de funções, como teste de interface , teste de automação de interface e gerenciamento de teste. Pode-se dizer que é um artefato único para a equipe de P&D melhorar a eficiência.

Resumir:

Obrigado a todos que leram meu artigo com atenção! ! !

Eu pessoalmente selecionei alguns materiais técnicos que compilei em minha carreira de teste de software nos últimos anos, incluindo: e-books, módulos de currículo, vários modelos de trabalho, livros de entrevistas, projetos de auto-estudo, etc. Sejam todos bem-vindos a clicar no cartão de visita abaixo para obtê-lo gratuitamente, não perca.