Construir e configurar uma ferramenta

Comece com a documentação oficial da API do serviço comercial e uma tarefa que a sua conta tem permissão para executar. Uma ferramenta restrita e bem descrita é mais fácil de testar do que uma ferramenta genérica que aceita URL e método arbitrários.

Defina a solicitação#

Atribua à ferramenta um nome estável e uma descrição que explique o seu propósito, limites importantes e se altera dados. Selecione o método HTTP e o endpoint documentados. Utilize espaços reservados apenas para os elementos do caminho variável que a operação realmente permite.

Para uma pesquisa de registo fictícia, o caminho pode conter um identificador de registo. O nome do host e a região da conta devem permanecer parte da ligação configurada, em vez da entrada do modelo aberto.

Definir e mapear entradas#

Utilize o esquema de entrada para descrever cada campo, o seu tipo, o estado obrigatório e os valores válidos. Um pequeno esquema para uma pesquisa fictícia é:

{
  "type": "object",
  "properties": {
    "record_id": {
      "type": "string",
      "description": "The verified identifier of the record to read"
    }
  },
  "required": ["record_id"],
  "additionalProperties": false
}

Mapeie argumentos para o caminho documentado, consulta ou campos de corpo. Verifique se os campos obrigatórios em falta e os argumentos extra inesperados falham claramente. Mantenha a autenticação na ligação do servidor compatível, e não num prompt, esquema de exemplo ou cabeçalho de ferramenta codificado.

Moldar a saída#

O mapeamento ou transformação de resposta pode devolver os campos necessários ao fluxo de trabalho, em vez de uma resposta de serviço inteira. Verifique a saída transformada em relação ao resultado do teste original. Não remova o identificador do registo, as informações de paginação ou os detalhes do erro necessários para compreender se o resultado está completo.

Reveja as configurações operacionais#

A configuração da ferramenta suporta as definições de tempo limite, cache e nova tentativa. Utilize o cache apenas quando os dados obsoletos forem aceitáveis; uma leitura em cache não é adequada como prova final de que uma escrita acabou de ser concluída. Tentar novamente uma escrita não idempotente pode criar duplicados, por isso escolha o comportamento de nova tentativa nas garantias documentadas da API.

Teste o caminho real#

Verifique a entrada correta, a entrada inválida, os resultados vazios, a falha de permissão e uma chamada bem-sucedida limitada. Os diagnósticos de teste podem conter informações confidenciais de solicitação; inspecione-os apenas através da rota aprovada do administrador e edite antes de partilhar. Ver testando antes de um cliente utilizar a ferramenta.