Compartilhar via

Editar uma API

APLICA-SE A: todas as camadas do Gerenciamento de API

Este artigo descreve como usar Azure API Management para editar uma API.

  • Você pode adicionar, renomear ou excluir operações no portal Azure.
  • Você pode editar o swagger da API.

Pré-requisitos

Navegar até a instância de Gerenciamento de API

  1. No Azure portal, pesquise e selecione API Management services:

    Captura de tela que mostra os serviços de Gerenciamento de API nos resultados da pesquisa.

  2. Na página Serviços de Gerenciamento de API , selecione sua instância de Gerenciamento de API:

    Captura de tela que mostra uma instância de Gerenciamento de API na página Serviços de Gerenciamento de API.

Editar uma operação

  1. Em APIs, selecione APIs.
  2. Selecione uma API importada.
  3. Selecione a guia Design.
  4. Selecione a operação que você deseja editar.
  5. Para renomear a operação, selecione o botão lápis no painel Front-end .

Captura de tela que mostra o processo de edição de uma API no Gerenciamento de API.

Atualizar o swagger

Você pode atualizar a documentação Swagger da sua API no Portal do Azure seguindo estas etapas:

  1. Na página APIs , selecione Todas as operações.

  2. Selecione o botão lápis no painel Front-end .

    Captura de tela que mostra o botão lápis no painel Front-end.

    O swagger da sua API é exibido.

    Captura de tela que mostra o swagger de uma API.

  3. Atualize o swagger.

  4. Clique em Salvar.

Atenção

Se você estiver editando uma revisão não atual de uma API, não poderá alterar as seguintes propriedades:

  • Nome
  • Tipo
  • Descrição
  • Assinatura necessária
  • Versão da API
  • Descrição da versão da API
  • Caminho
  • Protocolos

Se suas edições alterarem qualquer uma dessas propriedades em uma revisão não atual, você verá a mensagem Can't change property for non-current revisionde erro.

Conteúdo relacionado

  • Last updated on