Editar uma API

  • Artigo

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

As etapas neste tutorial mostram como usar o Gerenciamento de API para editar uma API.

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

Pré-requisitos

Navegar até a instância de Gerenciamento de API

  1. No portal do Azure, pesquise e selecione serviços de Gerenciamento de API.

    Selecione Serviços de Gerenciamento de API

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

    Selecione a sua instância de Gerenciamento de API

Editar uma operação

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

  1. Clique na guia APIs.
  2. Selecione uma das APIs que você importou anteriormente.
  3. Selecione a guia Design.
  4. Selecione uma operação que você deseja editar.
  5. Para renomear a operação, selecione um lápis na janela Front-end.

Atualizar o swagger

Você pode atualizar sua API de back-end do portal do Azure seguindo estas etapas:

  1. Selecione Todas as operações

  2. Clique no lápis na janela Front-end.

    Captura de tela que realça o ícone de lápis na tela Front-end.

    O swagger da sua API é exibido.

    Editar uma API

  3. Atualize o swagger.

  4. Pressione Salvar.

Cuidado

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 das propriedades acima de uma revisão não atual, a mensagem de erro Can't change property for non-current revision será exibida.

Próximas etapas

Exemplos de política de APIMTransformar e proteger uma API publicada