Developer Experience
6
min de leitura
15 de setembro de 2020

Como garantir um consumo bem sucedido de APIs?

Luciana Bandeira
Developer Experience
Ajudo desenvolvedores no onboarding e nas melhores práticas de APIs para garantir a melhor Developer Experience. No meu tempo livre me dedico a livros, pesquisar (e degustar) sobremesas e sou apaixonada por viajar.
Mais sobre o autor

Muitas ações, que às vezes podem até parecer triviais, podem ser realizadas para ajudar o desenvolvedor que está implementando o consumo de APIs a usá-lo corretamente, evitando assim uma sobrecarga de chamadas desnecessárias e incorretas, além de não entender os fluxos e as ações. Abaixo listaremos 10 passos que podem ajudar no processo de garantir o consumo de APIs e, portanto, seu uso de forma otimizada e bem sucedida.

10 passos para garantir o consumo bem sucedido de APIs

  1. Extração de métricas

Extraindo métricas de uso das solicitações executadas, você saberá exatamente o volume de uso e qual é o percentual de Erros X Sucessos, além de identificar as principais questões de APPs/desenvolvedor, operação e tipo de erro e, conseqüentemente, implementar ações para melhorar a experiência e o uso.

  1. Alinhamento constante de erros

O fornecimento de feedback ao desenvolvedor, com evidências e diretrizes para ajustes, permitirá alinhar os cenários de erro e fornecer informações para corrigir os problemas. Assumindo que seu desenvolvedor cometa erros devido a alguma falha no processo, é possível alinhar o mais rápido possível de acordo com as evidências e diretrizes para a correção dos erros internamente no processo de desenvolvimento.

  1. Monitorar chamadas de erro executadas

Além de extrair e identificar erros ao utilizar APIs, também é importante conduzir um monitoramento constante. Portanto, será uma ação eficaz para identificar a causa/razão de tais erros e também verificar se o desenvolvedor fez as correções necessárias. Esta ação também ajudará no item 2, onde será possível coletar as evidências para alinhamento com o desenvolvedor e monitorar a usabilidade.

  1. Portal do Desenvolvedor com documentação e insumos sobre o API

O Portal do Desenvolvedor é a entrada para o desenvolvedor que deseja consumir as APIs disponíveis e deve ser através dele que as informações e os guias do usuário estejam disponíveis.

  1. Documentação clara e elaborada sobre o Portal do Desenvolvedor

Isto dará suporte a todo o processo de onboarding e tornará o entendimento mais claro. Um Portal Dev de fácil comunicação é aquele que contém tanto linguagem técnica quanto comercial, para uma gama mais ampla de informações.

  1. Inclusão das melhores práticas no Dev Portal sobre o uso do API, regras de negócio, possível HTTP Status

Algumas das informações que acreditamos serem necessárias para incluir no Dev Portal, já que isso ajudará o desenvolvedor a entender as regras de forma mais objetiva, e assim poder incluir regras e informações no próprio desenvolvimento.

  1. Mensagem de retorno com informações de erro claras e explicativas

Isto facilitará a compreensão do desenvolvedor quando ocorrer um erro. Expor uma mensagem amigável quando ocorre um erro, além de padronizar HTTP Status, ajudará o desenvolvedor a identificar mais facilmente os erros e as causas.

  1. Desenvolvimento do reconhecimento dos retornos do lado do desenvolvedor

Por exemplo, o desenvolvedor precisa identificar o erro através da mensagem http status + erro exibida, e tomar as ações necessárias, evitando assim a continuação do cenário repetidamente.

  1. Swagger com qualidade

Um swagger muito detalhado com a descrição dos campos, exemplo de valores e todos os parâmetros de consulta ajudará os desenvolvedores e reduzirá o tempo de "descoberta" do uso.

  1. Ambiente de teste

Para a simulação dos processos que serão executados/utilizados na produção. Assim, o desenvolvedor será capaz de realizar os testes necessários e várias simulações, sem impactar o uso no ambiente de produção. Estes são alguns pontos a serem considerados em termos da experiência que os desenvolvedores estão tendo ao consumir suas APIs, sejam elas abertas ou privadas. Aqui na Sensedia, temos vários recursos que podem ajudá-lo a ter mais sucesso com as estratégias de distribuição e onboarding nas APIs para garantir que as melhores práticas estejam sendo aplicadas corretamente.

Obrigado pela leitura!