Este é o segundo artigo 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ê deveria se importar)
- Por que a experiência do desenvolvedor de APIs é importante – este artigo
As APIs estão no centro dos negócios modernos. Embora 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 áreas de negócios. Mas as APIs fazem mais do que apenas conectar dados e aplicações: elas são essenciais para colaborar com parceiros de negócios externos, prestar serviços aos clientes e gerar receita como produtos por si só.
Os desenvolvedores desempenham um papel fundamental no centro da economia de APIs. Responsáveis por criar, integrar e manter APIs, eles são tanto os criadores quanto os adotantes técnicos dessas interfaces. A experiência deles, comumente chamada de experiência do desenvolvedor de APIs, é um dos fatores mais importantes para determinar o sucesso geral de uma API. Este artigo explora os principais conceitos da experiência do desenvolvedor de APIs 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 APIs?
- Por que a experiência do desenvolvedor com APIs é importante?
- Como criar ótimas experiências para desenvolvedores de APIs?
O que é a experiência do desenvolvedor de APIs?
A experiência do desenvolvedor de API descreve as percepções e emoções gerais de um desenvolvedor ao interagir com uma API. Ela abrange a infraestrutura, as ferramentas, os processos, o suporte e outros pontos de contato que contribuem para uma experiência agradável e sem atritos para os desenvolvedores que integram APIs aos seus aplicativos. A experiência do desenvolvedor de API é uma subárea da experiência geral do desenvolvedor.
Por que a experiência do desenvolvedor com APIs é importante?
Se o foco incansável na experiência do usuário impulsionou a primeira geração de inovações tecnológicas, a próxima geração de empresas bem-sucedidas vencerá ao priorizar a experiência do desenvolvedor.
À medida que a economia de APIs continua a se expandir, os desenvolvedores passam a exercer maior influência sobre quais APIs são adotadas. Quando uma API é difícil de encontrar, não conta com documentação adequada ou recebe pouca manutenção, os desenvolvedores a abandonam em favor de uma alternativa mais simples e rápida. Isso se aplica tanto a programas internos de APIs quanto a APIs externas destinadas a parceiros e clientes.
No caso de APIs externas, há consequências comerciais concretas quando os desenvolvedores abandonam sua API. Você não perde apenas a receita proveniente de clientes diretos — também perde o acesso ao ecossistema mais amplo de produtos e soluções utilizados por seus clientes. Até mesmo os programas internos de APIs sofrem as consequências de uma experiência ruim para os desenvolvedores, como maior tempo de lançamento no mercado, redução da produtividade dos desenvolvedores e aumento do retrabalho, o que pode comprometer o sucesso da sua empresa.
Para ter sucesso em um mundo centrado nos desenvolvedores, você precisa de uma estratégia de API que forneça as ferramentas e os recursos certos para os desenvolvedores que atuam em todas as etapas do ciclo de vida da API. A melhor maneira de fazer isso é criar cuidadosamente uma experiência de API completa para os desenvolvedores, abrangendo três tipos de uso de APIs:
- Implantação e gerenciamento de APIs
- Descoberta e teste de APIs
- Monitoramento e proteção de APIs
Como criar ótimas experiências para desenvolvedores de APIs?
Criar uma experiência positiva envolve entender como os desenvolvedores usam sua API, do que precisam para concluir suas tarefas e, em última análise, como se sentem ao usar sua API. Depois de definir as personas que interagirão com suas APIs, você poderá começar a planejar a experiência geral com as APIs.
Há quatro princípios a serem considerados ao projetar a experiência do desenvolvedor com a API:
- Identifique os usuários – Quem está interagindo com a API?
- Definir a funcionalidade – O que a API faz?
- Otimizar a usabilidade – É fácil usar a API?
- Aprimore a experiência – Qual é a sensação de usar a API?
Vamos analisar cada princípio e o que você precisa oferecer para criar uma experiência ideal de uso da API para os desenvolvedores.
Etapa 1: Identifique os usuários
Assim como você desenvolve produtos para resolver problemas específicos dos clientes, é necessário projetar a experiência de uso das APIs em toda a sua infraestrutura e em seus produtos para atender às necessidades dos desenvolvedores. Os desenvolvedores são mais do que consumidores finais — eles também constroem e mantêm toda a infraestrutura.
Há três perfis principais a serem considerados ao projetar a experiência do desenvolvedor com uma API:
- Consumidores de APIs – Descobrem, implementam e mantêm integrações de APIs para seus aplicativos
- Proprietários de APIs – Planeje, crie, documente, teste, implante e gerencie APIs para seus serviços
- Gerentes de infraestrutura – Definem políticas globais e monitoram as APIs quanto à segurança e à conformidade
Talvez seja necessário considerar outros usuários e partes interessadas. Por exemplo, a categoria de consumidores de APIs pode incluir subcategorias de desenvolvedores internos, parceiros e clientes, cada uma com diferentes perfis e requisitos.
Etapa 2: Defina a funcionalidade
A funcionalidade é a base de APIs bem-sucedidas. Uma boa API permite que os desenvolvedores integrem dados ou serviços valiosos, concluam tarefas com mais rapidez e reduzam o tempo total dedicado ao desenvolvimento de novos recursos. Entre os principais aspectos a considerar estão:
- Qual valor a API oferece ao se integrar a dados ou serviços?
- Até que ponto a API resolve o problema reduzindo o número de chamadas e estruturando os dados?
- Qual é o nível de confiabilidade da API em termos de disponibilidade, confiabilidade e escalabilidade?
A funcionalidade de uma API está intimamente ligada à abordagem API-first de desenvolvimento. Ao contrário da abordagem “code first”, na “API first” a especificação da API é elaborada antes do início do desenvolvimento do código, com ênfase na estrutura das solicitações à API e nos dados retornados. Essa ênfase garante que a API forneça de forma consistente o valor e a funcionalidade de que os desenvolvedores precisam.
Etapa 3: otimize a usabilidade
O terceiro princípio, a usabilidade, trata de como os desenvolvedores usam suas APIs, e não do que podem fazer com elas. Ele abrange os recursos relacionados à sua API que facilitam a descoberta, o aprendizado, os testes e a integração. Sem um ecossistema de infraestrutura, ferramentas e documentação que ofereça o suporte necessário, os desenvolvedores terão dificuldade para usar suas APIs. Entre os aspectos importantes a considerar estão:
- Cadastro 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
- Configuração rápida com a criação de uma solicitação básica de API levando, idealmente, menos de cinco minutos
No Relatório sobre o Estado das APIs de 2022 da Postman, os participantes da pesquisa afirmaram que os principais obstáculos ao consumo de APIs são:
- Falta de documentação (55%)
- Dificuldade para descobrir APIs (38%)
- Falta de conhecimentos básicos sobre APIs (30%)
Você pode superar esses problemas utilizando portais centralizados para desenvolvedores, com documentação completa, exemplos de código e ferramentas para testar APIs.
Etapa 4: aprimore a experiência
A experiência do desenvolvedor com a API é o resultado de todas as interações entre o consumidor e o proprietário da API. Sua base está na funcionalidade e na usabilidade da API, mas há outras interações que contribuem para tornar a experiência de trabalhar com uma API mais agradável. Entre elas, estão:
- Comunidade ativa disponível em canais como Stack Overflow, Slack, Discord, Twitter etc.
- Suporte acessível com respostas rápidas das equipes de desenvolvimento
- Experiência sem atritos ao interagir com a API, a documentação e a comunidade
Desenvolvedores que gostam de trabalhar com suas APIs têm maior probabilidade de recomendá-las aos colegas, criar novos recursos com base nelas e integrá-las aos próprios aplicativos.
A experiência do desenvolvedor com APIs é importante
A chave para oferecer uma excelente experiência aos desenvolvedores de API está tanto na sua API quanto no ecossistema de ferramentas, processos, documentação e suporte ao redor dela. Quando todos os componentes do ecossistema da sua API funcionam de forma integrada, eles reduzem os atritos e a complexidade, permitindo que os desenvolvedores se concentrem na criação de aplicações.
As etapas discutidas acima fazem parte de um processo contínuo de projetar, implementar, testar e avaliar a experiência dos desenvolvedores com a API. Ao se concentrar em cada uma das principais etapas – identificar os usuários, definir as 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 dos desenvolvedores de APIs?
API Connectivity Manager, parte do F5 NGINX Management Suite, foi desenvolvido tendo como foco a experiência dos desenvolvedores de APIs. Com o API Connectivity Manager, as equipes de infraestrutura podem implantar gateways de API de alto desempenho e portais para desenvolvedores. Além disso, os desenvolvedores podem publicar e gerenciar rapidamente APIs e documentação, ou descobrir e integrar APIs a aplicações.
Os benefícios do API Connectivity Manager incluem:
- Integração rápida – Integre-se ao seu provedor de identidade preferido para simplificar 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 do portal do desenvolvedor quando os proprietários de APIs publicarem APIs no gateway de API
- Aprendizado interativo – Permita que os desenvolvedores descubram, testem e aprendam a usar suas APIs com um explorador de APIs integrado ao portal do desenvolvedor
- Automação de fluxos de trabalho – Integre a publicação e o gerenciamento de APIs aos seus pipelines de CI/CD usando uma API REST totalmente declarativa
Comece agora
Inicie uma avaliação gratuita de 30 dias do NGINX Management Suite, que inclui o API Connectivity Manager e o Instance Manager.
Recursos relacionados
- Blog: Conecte, dimensione e proteja aplicativos e APIs com o F5 NGINX Management Suite
- Blog: 5 maneiras de combater a proliferação de APIs (e por que você deveria se importar)
- Resumo da solução: NGINX Management Suite API Connectivity Manager
Sobre o autor
Publicações relacionadas no blog
Como o F5 NGINX One aprimora o gerenciamento e a observabilidade
Descubra como o F5 NGINX One aprimora o gerenciamento e a observabilidade de ambientes híbridos e multicloud ao oferecer um console web centralizado baseado em SaaS, com insights em tempo real, conformidade automatizada e gerenciamento simplificado de configurações.
Do OpenAPI ao NGINX como gateway de API usando uma API declarativa
Descubra como transformar uma definição de esquema OpenAPI em uma configuração NGINX totalmente funcional, operando como um API Gateway com a segurança de um Web Application Firewall e um Portal do Desenvolvedor, usando uma abordagem declarativa de API.
Como gerenciar picos repentinos de tráfego e sobrecarga do servidor
Picos de tráfego e sobrecarga de servidores são preocupações sérias para varejistas online em qualquer época, mas especialmente durante a “Cyber Season” de compras de fim de ano. Detalhamos como você pode aproveitar as soluções de entrega de aplicações de nível de produção da NGINX para se preparar para aumentos repentinos de tráfego.
Distribuição segura de chaves privadas SSL com o NGINX
Descrevemos três maneiras progressivamente mais seguras de proteger chaves privadas SSL ao configurar o NGINX para processar tráfego HTTPS: permitir acesso de leitura apenas ao usuário root, criptografar as chaves com senhas armazenadas separadamente e distribuir as senhas a partir de um repositório central.
Agrupando solicitações de API em lotes com NGINX Plus e o módulo JavaScript do NGINX
O módulo JavaScript do NGINX lançado com o NGINX Plus R15 oferece suporte a subsolicitações, possibilitando uma classe totalmente nova de casos de uso para o NGINX Plus. Este exemplo completo também usa a API do NGINX Plus e os módulos de chave-valor para converter solicitações de API dos clientes em solicitações separadas para as APIs dos microsserviços que compõem um aplicativo.
Como superar o esgotamento de portas efêmeras no NGINX e no NGINX Plus
Confira dicas para evitar o esgotamento de portas efêmeras com ajustes no kernel do Linux, conexões keepalive e conexões vinculadas dinamicamente a endereços IP locais.