O que é OpenAPI e porque deve ser usado

  • 5 minutos

O OpenAPI define uma descrição de interface padrão e independente da linguagem de programação para APIs Web. Permite que humanos e computadores descubram e compreendam os recursos de um serviço sem precisar acessar o código-fonte ou outra documentação ou inspecionar o tráfego de rede.

Captura de tela do OpenAPI.

Com um documento OpenAPI descrevendo uma API Web, o consumidor pode compreender e se comunicar com a API Web sem muito esforço.

Um conector personalizado pode ser criado para qualquer API Web, desde que seja corretamente descrito por um documento OpenAPI. Isso significa que a equipe de desenvolvimento de fusão da VanArsdel não está limitada a criar conectores personalizados para seus aplicativos do Power Apps de APIs Web hospedadas no Gerenciamento de API do Azure.

O que o documento OpenAPI faz?

O documento OpenAPI especifica um contrato da área de superfície da API Web. Ele abstrai as especificações da implementação real do consumidor da API. Isso significa que você pode criar rapidamente seu aplicativo sabendo quais métodos chamar e o que eles retornarão, sem precisar se preocupar com a forma como esses métodos são chamados.

Na unidade anterior, você usou o Gerenciamento da API do Azure para criar um conector personalizado. Fazendo isso, você também criou uma dependência no Gerenciamento de API do Azure. Em outras palavras, se qualquer alteração ocorrer no Gerenciamento de API do Azure, seu conector personalizado deve ser atualizado para refletir a alteração.

Com o documento OpenAPI, você não precisa saber onde a API está localizada ou se está em execução, porque o documento contém todas as informações necessárias.

O Power Apps permite criar instantaneamente um conector personalizado com este documento OpenAPI.

Captura de tela das muitas maneiras de criar um conector personalizado.

Depois de criar o conector personalizado do documento OpenAPI, você poderá vê-lo na sua página do Power Apps.

Captura de tela do conector personalizado no Power Apps.

Por que usar um documento OpenAPI para conectores personalizados?

Há várias vantagens em usar o documento OpenAPI para a criação de um conector personalizado. Mas os dois benefícios a seguir são os mais cruciais para desenvolvedores cidadãos.

  • Remover dependências: com um documento OpenAPI, você pode criar um conector personalizado por conta própria, sem precisar esperar que alguém crie um para você do Gerenciamento de API. Além disso, está se tornando mais comum que as equipes de desenvolvimento profissionais incluam recursos de geração de documentos OpenAPI na própria API Web. Isso significa que você pode baixar o documento OpenAPI visitando uma URL e criar o conector personalizado com ele.
  • Aumente a agilidade: a cadência do desenvolvimento do Power App aumenta quando sua equipe de desenvolvimento de API Web pode proporcionar a você um documento OpenAPI. Você não precisa depender deles para criar e usar um conector personalizado.

Como você pode ver no diagrama a seguir, o documento OpenAPI não precisa conhecer a implementação real da API Web, desde que o contrato permaneça o mesmo.

Diagrama de OpenAPI sem precisar conhecer a API Web.

Um conector personalizado de um documento OpenAPI ou do Gerenciamento de API Azure

Para criar um conector personalizado você pode usar o Gerenciamento de API do Azure ou um documento OpenAPI. Qual deles você deve escolher?

Esta tabela lista algumas comparações entre o Gerenciamento de API do Azure e o OpenAPI para conectores personalizados.

Conector Gerenciamento de API do Azure Documento do OpenAPI
Controle de API Centralizado Distribuído
Camada da estrutura da API Complexa Simples
Camada de segurança extra Sim Não
Controle de uso Sim Não
Custo extra Sim Não
Complexidade da arquitetura Maior Menor