Próximamente | API7 DevPortal - Llevando la Eficiencia de la Gestión de APIs al Siguiente Nivel

No mundo da computação atual, as pessoas se acostumaram a usar APIs como um meio de trocar informações entre aplicativos de software. Seja para verificar atualizações do tempo no celular, navegar pelos momentos do WeChat ou interagir com o ChatGPT, todas essas ações são possibilitadas por APIs. As APIs são um conjunto de convenções de comunicação que definem como você (ou seu software) pode interagir com o serviço de software de destino.

Gerenciamento do Ciclo de Vida Completo da API

À medida que uma empresa cresce, o número de APIs que ela utiliza pode aumentar rapidamente. A falha em gerenciar adequadamente essas APIs pode levar a uma série de problemas, como aumento dos custos de colaboração entre equipes, instabilidade do serviço e vulnerabilidades de segurança. Para abordar essas preocupações, o conceito de gerenciamento do ciclo de vida completo da API foi desenvolvido para fornecer uma abordagem abrangente ao gerenciamento de APIs.

O ciclo de vida da API pode ser dividido em diferentes estágios, desde o design até a aposentadoria, e geralmente consiste em três fases: planejamento e design, implementação e gerenciamento.

Planejamento e Design

Como engenheiros, sempre enfatizamos a importância de projetar soluções antes de escrever código, e as APIs não são exceção. Devemos definir o propósito de uma API com base nos requisitos de negócios e traduzir a linguagem de negócios em termos técnicos, utilizando a pilha técnica relevante.

Normalmente, o planejamento e design de APIs giram em torno da documentação. Por exemplo, ao projetar uma API RESTful, a documentação da API deve incluir as seguintes informações:

• Descrição da função da API
• URL correspondente para a API
• Método de requisição HTTP
• Descrição (e restrições) dos parâmetros de requisição, corpo da requisição e cabeçalhos da requisição
• Possíveis códigos de status de resposta e descrições do corpo da resposta

Há muita pesquisa sobre como escrever uma documentação de API clara e abrangente, e atualmente a abordagem popular é usar a Especificação OpenAPI V3.

No mundo real, o planejamento e design de APIs frequentemente envolvem colaboração entre várias pessoas. Para atender a essa necessidade, muitas plataformas dedicadas ao planejamento e design de APIs surgiram no mercado, como o Postman. Essas ferramentas permitem que os usuários projetem APIs visualmente e oferecem recursos de colaboração (principalmente em versões pagas). Elas também permitem que os usuários importem e exportem APIs em um formato específico para migração.

Implementação

Uma vez que o design da API esteja concluído, os engenheiros podem começar a desenvolvê-la. Eles podem escolher uma pilha tecnológica com a qual têm experiência ou que a organização exija para implementar a API. Durante o desenvolvimento, os engenheiros também podem testar a API adicionando testes de ponta a ponta ou solicitando testes da equipe de QA. Uma vez que a implementação esteja concluída, os engenheiros podem se preparar para implantar a API.

Estágio de Gerenciamento

Em comparação com os estágios anteriores, o estágio de gerenciamento de uma API é mais complexo, pois envolve implantação, monitoramento, depuração e reforço de segurança. É aqui que um gateway de API desempenha um papel crucial. Expor diretamente a instância do serviço após a implantação não é seguro nem escalável.

Em vez disso, um gateway de API atua como um proxy, encaminhando as requisições da API para o serviço real. Com um gateway de API, políticas como limitação de taxa podem ser configuradas para evitar sobrecarga do serviço de API, autenticação para permitir acesso apenas a usuários autorizados e observabilidade para monitorar o status das chamadas de API em tempo real. Em resumo, um gateway de API é um componente essencial no gerenciamento da segurança, escalabilidade e desempenho de uma API.

De fato, as APIs não são estáticas, e os engenheiros devem iterar constantemente sobre sua funcionalidade e corrigir quaisquer defeitos que surjam. Assim, as APIs geralmente transitam entre os vários estágios de planejamento e design, implementação e gerenciamento antes de serem totalmente aposentadas. Esse processo cíclico garante que as APIs permaneçam atualizadas e eficazes ao longo de seu ciclo de vida.

Consumo de API

O gerenciamento do ciclo de vida completo da API simplifica o gerenciamento de APIs do ponto de vista dos produtores de API (ou seja, desenvolvedores e mantenedores de APIs). No entanto, ele não aborda a questão do consumo de APIs, ou seja, como permitir que desenvolvedores externos (que podem ser de diferentes equipes dentro da mesma empresa) integrem facilmente a API. Para permitir que um desenvolvedor externo chame sua API, há várias questões que precisam ser resolvidas:

• A primeira questão a ser abordada é como permitir que desenvolvedores externos acessem informações da API, incluindo endereços de acesso, descrições, restrições de parâmetros, exemplos de uso e mais. Essas informações detalhadas são essenciais para ajudar os desenvolvedores externos a entender e usar efetivamente a API.
• A segunda questão diz respeito à proteção da API, que é crítica para os produtores de API. É imperativo garantir que apenas desenvolvedores autorizados possam acessar e usar a API com credenciais válidas.
• Por fim, para reduzir o custo de comunicação e colaboração, o consumo de API deve ser o mais autossuficiente possível.

Para resolver essas questões e otimizar o consumo de API, o conceito de portal do desenvolvedor foi introduzido.

Portal do Desenvolvedor

Um portal do desenvolvedor permite que desenvolvedores externos descubram e acessem APIs, revisem documentação detalhada, testem APIs e obtenham credenciais válidas de API. Ele serve como uma plataforma de autoatendimento para desenvolvedores externos, permitindo que eles acessem APIs de forma mais eficiente e reduzindo a carga sobre os produtores de API.

O portal do desenvolvedor geralmente consiste em dois sites: o site de gerenciamento e o site do desenvolvedor. O site de gerenciamento é usado pelos produtores de API (doravante chamados de administradores), enquanto o site do desenvolvedor é usado pelos consumidores de API (doravante chamados de desenvolvedores).

O site de gerenciamento do portal do desenvolvedor desempenha um papel crítico ao permitir que os administradores gerenciem efetivamente a liberação e a descontinuação de APIs. Apenas as APIs que foram liberadas são visíveis no site do desenvolvedor. Os administradores também podem aplicar políticas, como limites de QPS e requisitos de autenticação, para garantir que as APIs estejam protegidas. Além disso, os administradores podem revisar solicitações do site do desenvolvedor, incluindo registro de contas de desenvolvedores e solicitações de assinatura para APIs específicas. Certos produtos de portal do desenvolvedor até oferecem a opção de os administradores personalizarem a aparência do site do desenvolvedor, como substituir o logotipo ou modificar o slogan.

O site do desenvolvedor é projetado para os consumidores de API. Aqui, os desenvolvedores podem visualizar todas as APIs publicadas pelos administradores, incluindo suas informações detalhadas, e solicitar assinaturas de APIs. Eles podem criar credenciais de acesso para as APIs assinadas e aprender como integrá-las consultando a documentação da API.

Alguns portais do desenvolvedor integram análises de chamadas de API, exibindo o número de chamadas e a latência de APIs específicas do ponto de vista do desenvolvedor no site de gerenciamento. Esses dados podem servir como base para decisões sobre iterações futuras e otimização da API, ajudando a melhorar seu desempenho.

À medida que o ecossistema de APIs continua a evoluir, o conceito de monetização de API está recebendo cada vez mais atenção. O portal do desenvolvedor se tornou uma ferramenta valiosa para a monetização de APIs. Os administradores podem criar vários planos de assinatura para APIs e cobrar taxas diferentes com base em cotas variáveis ou no número de chamadas de API.

O Próximo API7 DevPortal

A API7.ai está comprometida em fornecer serviços de gerenciamento de API incomparáveis aos nossos usuários. Estamos animados em anunciar nossa mais nova oferta, o API7 DevPortal, um produto abrangente de portal do desenvolvedor que se integra perfeitamente à nossa solução de gateway de API de nível empresarial, API7 Enterprise, construída sobre o Apache APISIX.

O API7 DevPortal foi projetado para atender às necessidades de nossos clientes, oferecendo recursos como aprovação de assinaturas de API e registro de desenvolvedores. Com nosso portal do desenvolvedor, os clientes podem publicar facilmente suas APIs proxy do gateway, fornecendo aos seus desenvolvedores informações detalhadas sobre as APIs no site do desenvolvedor.

Além disso, entendemos a importância de simplificar fluxos de trabalho para aumentar a produtividade e impulsionar o crescimento da receita. Portanto, o API7 DevPortal passará por duas iterações significativas no futuro.

• Primeiro, integraremos com os fluxos de aprovação de nossos clientes. Alguns de nossos clientes têm uma plataforma de aprovação unificada para gerenciar várias operações de aprovação. Nosso objetivo é permitir que os clientes usem o API7 DevPortal sem alterar seus hábitos de aprovação existentes.

• Em segundo lugar, suportaremos a monetização de API para ajudar nossos clientes a fornecer serviços de assinatura em diferentes níveis para desenvolvedores e suportar a cobrança de taxas. Em breve, lançaremos o API7 DevPortal no mercado.

Se você estiver interessado neste produto, clique aqui para entrar em contato conosco.

Resumo

Os portais do desenvolvedor desempenham um papel crítico no gerenciamento do consumo de API, permitindo que os produtores de API resolvam efetivamente problemas de integração de API sem comprometer a segurança e facilitando a monetização. No mundo atual, impulsionado por APIs, é essencial considerar a implementação de um portal do desenvolvedor na estratégia de gerenciamento de API da sua equipe.