Por que a experiência do desenvolvedor de API é importante
Esta é a segunda postagem de uma série de duas partes sobre o API Connectivity Manager:
- 5 maneiras de combater a proliferação de APIs (e por que você deve se importar)
- Por que a experiência do desenvolvedor de API é importante – esta postagem
As APIs estão no centro dos negócios modernos. Embora as APIs sempre tenham desempenhado um papel importante no desenvolvimento de software, a crescente demanda por integração de dados está levando à adoção mais ampla de APIs em todas as linhas de negócios. Mas as APIs fazem mais do que apenas conectar dados e aplicativos – elas são essenciais para colaborar com parceiros comerciais externos, fornecer serviços aos clientes e gerar receita como produtos por si só.
Os desenvolvedores desempenham um papel fundamental no centro da economia de API. Responsáveis por criar, integrar e manter APIs, eles são tanto os criadores quanto os adotantes técnicos das APIs. A experiência deles, comumente chamada de experiência do desenvolvedor de API , é um dos fatores mais importantes para determinar o sucesso geral de uma API. Este post explora os principais conceitos da experiência do desenvolvedor de API e o que os líderes de TI precisam considerar ao planejar a experiência de API.
- O que é a experiência do desenvolvedor de API?
- Por que a experiência do desenvolvedor de API é importante?
- Como você cria ótimas experiências para desenvolvedores de API?
O que é a experiência do desenvolvedor de API?
A experiência do desenvolvedor de API descreve as percepções e emoções gerais que um desenvolvedor tem ao interagir com uma API. Ela abrange a infraestrutura, ferramentas, processos, suporte e outros pontos de contato que contribuem para uma experiência agradável e sem atrito para desenvolvedores que integram APIs em seus aplicativos. A experiência do desenvolvedor de API é uma subprática da experiência geral do desenvolvedor.
Por que a experiência do desenvolvedor de API é importante?
Se um foco implacável na experiência do usuário impulsionou a primeira geração de inovação tecnológica, então a próxima geração de empresas bem-sucedidas vencerá com foco na experiência do desenvolvedor .
À medida que a economia de APIs continua a se expandir, os desenvolvedores estão ganhando maior influência sobre quais APIs são adotadas. Quando uma API é difícil de descobrir, não possui documentação adequada ou é mal mantida, os desenvolvedores a abandonam em favor de uma alternativa mais simples e rápida. Isso se aplica igualmente aos programas de API internos e também às APIs externas para parceiros e clientes.
No caso de APIs externas, há consequências comerciais tangíveis quando os desenvolvedores abandonam sua API. Você não está apenas perdendo receita de clientes diretos – você está perdendo acesso ao ecossistema mais amplo de produtos e soluções usados por seus clientes. Até mesmo programas internos de API enfrentam consequências de uma experiência ruim para o desenvolvedor, incluindo menor tempo de lançamento no mercado, menor produtividade do desenvolvedor e maior retrabalho, o que pode comprometer o sucesso do seu negócio.
Para vencer no mundo centrado no desenvolvedor, você precisa de uma estratégia de API que forneça as ferramentas e os recursos certos para os desenvolvedores que trabalham em cada estágio do ciclo de vida da API. A melhor maneira de fazer isso é criando uma experiência de API completa e bem pensada para desenvolvedores, que englobe três tipos de uso de API:
- Implantando e gerenciando APIs
- Descobrindo e testando APIs
- Monitoramento e proteção de APIs
Como criar ótimas experiências para desenvolvedores de API?
Criar uma experiência positiva é entender como os desenvolvedores usam sua API, o que eles precisam para concluir suas tarefas e, finalmente, como eles se sentem ao usar sua API. Depois de definir as personas que irão interagir com suas APIs, você pode começar a planejar a experiência geral da API.
Há quatro princípios a serem considerados ao projetar a experiência do desenvolvedor de API:
- Identificar usuários – Quem está interagindo com a API?
- Definir funcionalidade – O que a API faz?
- Otimizar a usabilidade – Quão fácil é usar a API?
- Melhore a experiência – Qual é a sensação de usar a API?
Vamos analisar cada princípio e o que você precisa fornecer para criar uma experiência de API ideal para desenvolvedores.
Passo 1: Identificar usuários
Assim como você projeta produtos para problemas específicos do cliente, você precisa projetar a experiência da API em sua infraestrutura e produtos para atender às preocupações do desenvolvedor. Os desenvolvedores são mais do que o consumidor final – eles também são os construtores e mantenedores da infraestrutura geral.
Há três personas principais a serem consideradas ao projetar uma experiência de desenvolvedor de API:
- Consumidores de API – Descubra, implemente e mantenha integrações de API para seus aplicativos
- Proprietários de API – Planeje, crie, documente, teste, implante e gerencie APIs para seus serviços
- Gerentes de infraestrutura – Defina políticas globais e monitore APIs para segurança e conformidade
Você pode ter usuários e partes interessadas adicionais a serem considerados. Por exemplo, a categoria de consumidores de API pode incluir subcategorias de desenvolvedores internos, parceiros e clientes, cada um com diferentes personas e requisitos.
Passo 2: Definir funcionalidade
A função é a base de APIs bem-sucedidas. Uma boa API permite que os desenvolvedores se integrem com dados ou serviços valiosos, concluam tarefas mais rapidamente e reduzam o tempo geral gasto no desenvolvimento de novos recursos. As principais considerações incluem:
- Que valor a API oferece ao integrar-se com dados ou serviços?
- Quão bem a API resolve o problema reduzindo chamadas e estruturando os dados?
- Quão confiável é a API em termos de disponibilidade, confiabilidade e escalabilidade?
A funcionalidade de uma API está intimamente interligada com a abordagem API‑first para desenvolvimento. Em contraste com “code first”, com “API first” a especificação da API é escrita antes do início do desenvolvimento do código, com ênfase na estrutura das solicitações da API e nos dados retornados. Essa ênfase garante que a API forneça consistentemente o valor e a funcionalidade que os desenvolvedores precisam.
Etapa 3: Otimizar a usabilidade
O terceiro princípio, usabilidade, aborda como os desenvolvedores usam suas APIs, em vez do que eles podem fazer com elas. Ele abrange os recursos em torno da sua API que dão suporte à descoberta, aprendizado, testes e integração. Sem um ecossistema de suporte de infraestrutura, ferramentas e documentação, os desenvolvedores terão problemas para usar suas APIs. Considerações importantes incluem:
- Inscrição simples com login único (SSO) integrado e gerenciamento fácil de chaves de API
- Documentação clara e completa com referências atualizadas e exemplos de código
- Tempo de configuração rápido com a criação de uma solicitação de API básica, idealmente levando menos de cinco minutos
No Relatório do Estado da API de 2022 do Postman, os entrevistados disseram que os principais obstáculos ao consumo de APIs são:
- Falta de documentação (55%)
- Problemas para descobrir APIs (38%)
- Falta de conhecimento fundamental de API (30%)
Você pode superar esses problemas aproveitando portais centrais de desenvolvedores com documentação completa, exemplos de código e ferramentas para testar APIs.
Passo 4: Melhore a experiência
A experiência do desenvolvedor da API é a soma das interações entre o consumidor da API e o proprietário da API. A fundação é construída sobre a funcionalidade e usabilidade da API, mas há interações adicionais que contribuem para o prazer geral de trabalhar com uma API. Elas podem incluir:
- Comunidade ativa disponível em canais como Stack Overflow, Slack, Discord, Twitter, etc.
- Suporte acessível com respostas oportunas das equipes de desenvolvimento
- Experiência sem atrito ao interagir com a API, documentação e comunidade
Desenvolvedores que gostam de trabalhar com suas APIs têm mais probabilidade de recomendá-las a seus colegas, criar novos recursos em torno delas e integrá-las em seus aplicativos.
A experiência do desenvolvedor de API é importante
A chave para uma ótima experiência de desenvolvedor de API inclui sua API, bem como o ecossistema de ferramentas, processos, documentação e suporte em torno dela. Quando todas as partes do seu ecossistema de API operam perfeitamente, o atrito e a complexidade são reduzidos para que os desenvolvedores possam se concentrar na criação de aplicativos.
As etapas discutidas acima fazem parte de um processo contínuo de design, implementação, teste e avaliação da experiência do desenvolvedor de API. Se você se concentrar em cada uma das etapas principais – identificar usuários, definir funcionalidades, otimizar a usabilidade e aprimorar a experiência – você pode criar APIs que sejam agradáveis e até divertidas de usar.
Como o NGINX melhora a experiência do desenvolvedor de API?
O API Connectivity Manager , parte do F5 NGINX Management Suite , foi projetado com a experiência do desenvolvedor de API em seu núcleo. Com o API Connectivity Manager, as equipes de infraestrutura podem implantar gateways de API e portais de desenvolvedores de alto desempenho. E os desenvolvedores podem publicar e gerenciar APIs e documentação rapidamente ou descobrir e integrar APIs em aplicativos.
Os benefícios do API Connectivity Manager incluem:
- Integração rápida – Integre-se com seu provedor de identidade favorito para agilizar a autorização e a autenticação no portal do desenvolvedor
- Documentação simples – Use a especificação OpenAPI para gerar automaticamente a documentação para o portal do desenvolvedor quando os proprietários da API publicam APIs no gateway da API
- Aprendizagem interativa – Permita que os desenvolvedores descubram, testem e aprendam suas APIs com um explorador de API integrado no portal do desenvolvedor
- Automação de fluxo de trabalho – Integre a publicação e o gerenciamento de API em seus pipelines de CI/CD usando uma API REST totalmente declarativa
Iniciar
Inicie uma avaliação gratuita de 30 dias do NGINX Management Suite , que inclui o API Connectivity Manager e o Instance Manager .
Recursos relacionados
"Esta postagem do blog pode fazer referência a produtos que não estão mais disponíveis e/ou não têm mais suporte. Para obter as informações mais atualizadas sobre os produtos e soluções F5 NGINX disponíveis, explore nossa família de produtos NGINX . O NGINX agora faz parte do F5. Todos os links anteriores do NGINX.com redirecionarão para conteúdo semelhante do NGINX no F5.com."