5 maneiras de melhorar a descoberta da API

5 maneiras de melhorar a descoberta da API

cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br


Este é o primeiro artigo de uma série de duas partes focada na documentação e descoberta de API

A experiência do desenvolvedor de API

As APIs não são mais tratadas apenas como uma tecnologia de integração, mas também são vistas como produtos de software que podem capacitar uma organização com canais de negócios digitais modernos e oportunidades de receita adicionais. As equipes de desenvolvimento mais avançadas e experientes estão construindo APIs reutilizáveis ​​que podem aumentar a velocidade de desenvolvimento em toda a organização, permitindo uma entrada no mercado mais rápida e fomentando uma cultura de inovação.

Freqüentemente, muito sangue, suor e lágrimas vão para o processo de desenvolvimento da API. Mas uma vez que as APIs são desenvolvidas, o desenvolvedor precisa remover seu chapéu de ‘desenvolvedor’ e pensar como um consumidor de API para criar uma ‘experiência de desenvolvedor de API’ centrada no consumidor. Uma experiência de desenvolvedor de API ideal atende a públicos técnicos e de negócios, permitindo que eles descubram e consumam as APIs sem esforço.

Os fatores mais importantes que contribuem para a experiência do desenvolvedor de API são: descoberta da API e documentação da API.

Nesta parte do blog da série de duas partes, vamos nos concentrar em como tornar as APIs verdadeiramente detectáveis ​​usando Anypoint Exchange, permitindo um consumo mais amplo.

Habilitando a descoberta de API

O Google estabeleceu padrões elevados quando se trata de pesquisa, tanto que se tornou uma tarefa hercúlea para outras empresas desenvolver sua própria experiência de pesquisa integrada. Muitos sites de API não têm mecanismos de pesquisa robustos e abrangentes, tornando assim difícil para os consumidores encontrar as APIs certas.

Usar o Anypoint Exchange para publicar suas APIs torna mais fácil descobrir suas APIs. Ele apresenta recursos abrangentes de pesquisa e filtro. A equipe MuleSoft responsável pelo Anypoint Exchange faz um esforço constante para melhorar a experiência de pesquisa de seus usuários.

Aqui estão as cinco ferramentas do Exchange que tornam suas APIs verdadeiramente detectáveis:

# 1 Pesquisa

A pesquisa do Exchange permite que seus usuários encontrem APIs e outros ativos hospedados no Exchange. Quando um usuário pesquisa uma string específica, o Exchange expande esse termo de pesquisa e procura correspondências em:

  • Nome e descrição da API
  • Conteúdo de marcação na documentação da API
  • Tag
  • Categorias
  • Os campos personalizados
  • Propriedades nas especificações da API (URL base, método, características, endpoints, etc.)

A pesquisa do Exchange também fornece insights para os usuários sobre ‘critérios de correspondência’, o que destaca por que uma API está sendo exibida nos resultados da pesquisa.

Essa pesquisa abrangente atinge o alvo quando se trata de retornar os resultados de API corretos para o consumidor.

cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br

# 2 Filtros

O Exchange também fornece uma solução de filtro avançada e dinâmica que pode restringir os resultados da pesquisa aos ativos de API mais relevantes. O Exchange agora oferece um total de quatro filtros que podem ser aplicados ao termo de pesquisa.

Abaixo estão os filtros disponíveis:

  • Tipo: Permite que os usuários filtrem o tipo de API ou ativo, por exemplo, API Rest, API SOAP, Conector, etc.
  • Organização: Permite que os usuários filtrem as APIs com base em qual organização ou grupo de negócios uma API pertence.
  • Categoria: Permite que os usuários filtrem APIs com base em sua categorização.
  • Tag: Permite que os usuários filtrem as tags adicionadas às versões da API.

# 3 Salvar pesquisas

Conforme as organizações crescem, também cresce sua rede de aplicativos. Os administradores do Exchange de uma organização podem aproveitar esse recurso para salvar as combinações de pesquisa e filtro mais comuns para todos em sua organização para usar como pesquisas salvas. Isso torna mais fácil para os consumidores descobrirem as APIs e acelerar seu processo de desenvolvimento.

# 4 categorias

O Exchange fornece configurações de categorização para APIs que podem ser agrupadas em categorias. Isso permite que os consumidores filtrem por uma categoria específica de interesse e encontrem o conjunto relevante de APIs.

As categorias de APIs e ativos podem ser personalizadas de acordo com as necessidades e o ambiente de sua organização. Algumas das categorias comuns e os valores que podem ser criados são os seguintes:

  • Camada de API: sistema, processo ou experiência
  • Sistemas de aplicativos: Salesforce, SAP, banco de dados, etc.
  • Social: Facebook, Twitter, Instagram, etc.

# 5 Tags

Além disso, usando o Tag recurso, as organizações podem rotular suas APIs para impulsionar ainda mais a descoberta e o consumo de ativos. Aplicar várias tags a uma API é uma prática recomendada ao lidar com aplicativos complexos ou de uso amplo. Por exemplo, quando uma API de sistema do Salesforce é marcada com sfdc e system-api, um consumidor que procura uma API semelhante pode simplesmente descobri-la usando qualquer um desses filtros.

Conclusão

Imagine ir a um grande supermercado que não tenha placas ou descrições de corredor. Seria um verdadeiro pesadelo fazer compras e encontrar as coisas que procura. Da mesma forma, os consumidores de API podem se sentir perdidos sem boas práticas de descoberta de API. A experiência de pesquisa integrada do Exchange, combinada com a utilização diligente de categorias e tags, contribui muito para fornecer experiência superior de desenvolvedor de API.

Em meu próximo blog, veremos como conseguir uma ótima documentação de API com Anypoint Exchange. Para obter mais informações sobre como obter aos desenvolvedores acesso rápido à API em um portal fácil de navegar, confira nosso curso de treinamento Anypoint Platform: API Design.


cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br
Luiz Presso
Luiz Presso