Usando um portal do desenvolvedor para gerenciamento de API

Um catálogo de APIs é como uma biblioteca superorganizada onde você pode facilmente encontrar e usar diferentes APIs. Os catálogos de APIs privadas incluem todas as APIs internas usadas em uma organização. Isso otimiza o gerenciamento de APIs, identificando códigos redundantes e promovendo a adesão aos padrões de toda a organização. Um catálogo de APIs privado atua como um repositório centralizado para todas as APIs internas, proporcionando visibilidade abrangente do cenário de APIs de uma organização.

Catálogos de API privados geram vantagens tanto para desenvolvedores quanto para líderes de engenharia. Os desenvolvedores se beneficiam ao evitar a necessidade de codificar repetidamente fluxos de trabalho comuns, como autenticação de usuário. Em vez disso, eles podem aproveitar APIs desenvolvidas por outras equipes para fins semelhantes. Além disso, os catálogos de API fornecem insights em tempo real sobre tendências internas de uso de API, permitindo decisões informadas sobre a alocação de recursos. Por fim, a natureza centralizada dos catálogos de API simplifica a aplicação de uma estratégia eficaz de governança de API em todas as equipes organizacionais e evita microsserviços desnecessários ou APIs órfãs.

Você pode criar um catálogo de API em seu portal interno do desenvolvedor, tornando-o parte do catálogo geral de software em seu portal interno do desenvolvedor. Os portais contêm mais do que apenas catálogos de software. Eles fornecem ações de autoatendimento que simplificam o processo de chamada e consumo de APIs, eliminam codificação duplicada e fornecem visibilidade e contexto.

Você pode obter um valor significativo mantendo um catálogo de API em um portal de desenvolvedor interno como o Port. Para obter mais informações e uma demonstração completa, assista a este webinar.

Usando o Portal Interno do Desenvolvedor como um Catálogo de API

As arquiteturas de microsserviços geralmente têm uma série de APIs que se comunicam entre si por meio de diversas interfaces e métodos. Ao rastrear essas APIs, você pode obter uma camada de observabilidade e contexto de alta qualidade. Por exemplo, rastrear versões, uso e dependências de API ajuda a verificar se as APIs estão funcionando corretamente ou a identificar rapidamente quaisquer possíveis problemas.

No entanto, os desenvolvedores podem ter dificuldades para chamar, rastrear e implantar APIs. A depuração e a solução de problemas exigem um conhecimento profundo das APIs e das complexidades dos microsserviços, nas quais nem todos os desenvolvedores têm tempo para se aprofundar. O mesmo vale para a integração com sistemas terceiros ou novos, o que exige um conhecimento profundo de cada sistema. Existem também demandas de segurança, que exigem colaboração com equipes de segurança e compreensão dos requisitos de segurança. E a lista continua.

Uma das principais vantagens de ter um catálogo de APIs em um portal interno para desenvolvedores é que ele pode responder a esses desafios e muito mais, abstraindo complexidades e mostrando aos desenvolvedores apenas as informações de que precisam para as ações de API que precisam realizar em um determinado momento. Isso ajuda a simplificar e gerenciar o processo com eficiência e escala, o que reduz a carga cognitiva e libera os desenvolvedores para se concentrarem em suas atividades principais, como escrever código escalonável e de alto desempenho para as APIs.

Como usar dados de API em um portal interno para desenvolvedores

Um catálogo de APIs é um ativo estratégico que aumenta a eficiência, a segurança e a escalabilidade da infraestrutura de APIs de uma organização. Algumas implementações práticas incluem:

Solução de problemas e manutenção

Quando surgem problemas, os desenvolvedores podem consultar rapidamente o catálogo de software para isolar o problema e compreender seu impacto nos sistemas interconectados. Por exemplo, observando o tempo ou status de resposta da verificação de integridade mais recente, você pode ver se os endpoints da API estão degradados, não íntegros ou indisponíveis. Além disso, você pode usar essas informações para identificar rapidamente a causa raiz do problema e tomar medidas corretivas.

O catálogo de software também fornece aos desenvolvedores contexto adicional sobre as APIs fornecidas e consumidas pelos serviços. Essas informações são valiosas como medida proativa para prevenir incidentes.

Resposta de plantão

Se um desenvolvedor precisar cuidar de um incidente relacionado à API, o portal fornece orientação de forma automatizada e de autoatendimento. Esse processo simplificado torna muito fácil para o desenvolvedor de plantão cuidar de um incidente, mesmo que sejam 4 da manhã, eles acabaram de acordar e é uma API de missão crítica.

Integração e treinamento

Novos membros da equipe podem usar o catálogo de software como ferramenta de aprendizagem para compreender a infraestrutura de API da organização, acelerando o processo de integração. Se um desenvolvedor precisar adicionar um novo recurso ou desenvolver uma nova API, ele pode estar se perguntando se já existe uma funcionalidade semelhante dentro da organização. Nesse caso, eles podem usar o endpoint que já existe em vez de desenvolvê-lo.

Desenvolvimento Contínuo

Um catálogo de APIs fornece aos desenvolvedores informações sobre APIs existentes, evitando que eles desenvolvam novamente um endpoint que já existe.

Planejamento estratégico

Ao construir o catálogo da API dentro do catálogo de software do portal, os tomadores de decisão podem obter uma visão geral clara do cenário da API, o que ajuda no planejamento estratégico e na alocação de recursos.

Demonstração: Construa um Catálogo de API no Porto Usando Blueprints

No Port, o catálogo do software é definido por meio de blueprints.

Para construir o catálogo de API, você definirá um blueprint de API Endpoint. Ele conterá o esquema de dados para todas as entidades de endpoint da API que você incluirá no catálogo de software. Isso agregará todos os endpoints da API em um único painel, tornando mais fácil para os desenvolvedores e partes interessadas visualizarem imediatamente todo o cenário da API. Como resultado, eles podem identificar APIs rapidamente, compreender suas funções e monitorar seu status, desempenho e integridade.

Defina um plano que inclua:

• Método HTTP
• Status da verificação de integridade do endpoint
• Último tempo de resposta da verificação de integridade
• Exemplos de respostas
• Solicitações de exemplo, que facilitam a integração deste serviço e endpoint e a compreensão de como usar esta API

Agora, conecte o blueprint do endpoint da API a blueprints de porta adicionais usando relacionamentos. Nesse caso, você está se conectando aos blueprints de Serviço em Execução, Ambiente e Serviço.

Essas conexões possibilitam aproveitar o contexto adicional fornecido pelo portal do desenvolvedor. Os desenvolvedores poderão fazer (e responder) perguntas como a qual serviço esse endpoint da API pertence ou qual é o tempo de resposta da API em execução na região dos EUA.

Catálogo de software API em ação

Agora que você construiu o catálogo da API usando blueprints, veja como ele fica. Para adicionar APIs ao catálogo pela primeira vez, verifique seu arquivo de especificação de API, como Swagger, OpenAPI, AsyncAPI ou Protobuf.

A seção de endpoint da API no catálogo de software exibe todos os endpoints da organização, com informações como quando foi atualizado pela última vez, seu método HTTP, status de integridade, o tempo de resposta da verificação de integridade mais recente e qual serviço fornece o endpoint. Esta página permite que você acompanhe o desempenho das APIs.

Os endpoints na imagem abaixo, tanto em teste quanto em produção, estão íntegros e o tempo de resposta é baixo e aceitável.

Observando um serviço em execução, você pode ver os endpoints que ele está expondo. Você pode usar isso, por exemplo, para ver a diferença entre diferentes versões implantadas (o que pode ser útil com sinalizadores de recursos), comparando o teste com a produção ou entendendo se há uma certa degradação de desempenho em versões mais recentes ou entre regiões.

Gerenciamento de API simplificado

Um portal interno para desenvolvedores é uma ótima solução para gerenciar complexidades de API em uma arquitetura de microsserviços. Serve como um ativo estratégico, melhorando significativamente a eficiência, a segurança e a escalabilidade da infraestrutura de API da sua organização. Ao fornecer uma interface centralizada, fácil de usar e de autoatendimento, o portal simplifica processos de API como solução de problemas, manutenção, integração e planejamento estratégico.

O catálogo de APIs no portal interno do desenvolvedor do Port oferece insights abrangentes e em tempo real sobre a integridade e o desempenho das APIs. Os desenvolvedores se beneficiam da carga cognitiva reduzida e dos fluxos de trabalho automatizados, permitindo que se concentrem nas principais tarefas de desenvolvimento e inovem sem ter que perder tempo descobrindo as complexidades do gerenciamento de API.

Experimente o Porto você mesmo.

A postagem Usando um portal de desenvolvedor para gerenciamento de API apareceu pela primeira vez em The New Stack.