Skip to content

Files

Latest commit

 

History

History
78 lines (57 loc) · 2.29 KB

edit-api.md

File metadata and controls

78 lines (57 loc) · 2.29 KB
title description services documentationcenter author editor ms.service ms.workload ms.tgt_pltfrm ms.topic ms.date ms.author
Edit an API with the Azure portal | Microsoft Docs
Learn how to use API Management (APIM) to edit an API. Add, delete, or rename operations in the APIM instance, or edit the API's swagger.
api-management
adrianhall
api-management
mobile
na
article
01/19/2022
adhal

Edit an API

The steps in this tutorial show you how to use API Management (APIM) to edit an API.

  • You can add, rename, or delete operations in the Azure portal.
  • You can edit your API's swagger.

Prerequisites

[!INCLUDE api-management-navigate-to-instance.md]

Edit an API in APIM

Screenshot that highlights the process for editing an API in APIM.

  1. Click the APIs tab.
  2. Select one of the APIs that you previously imported.
  3. Select the Design tab.
  4. Select an operation, which you want to edit.
  5. To rename the operation, select a pencil in the Frontend window.

Update the swagger

You can update your backbend API from the Azure portal by following these steps:

  1. Select All operations

  2. Click pencil in the Frontend window.

    Screenshot that highlights the pencil icon in the Frontend screen.

    Your API's swagger appears.

    Edit an api

  3. Update the swagger.

  4. Press Save.

Caution

If you are editing a non-current revision of an API, you cannot change the following properties:

  • Name
  • Type
  • Description
  • Subscription required
  • API version
  • API version description
  • Path
  • Protocols

If your edits change any of the above properties of a non-current revision, the error message Can't change property for non-current revision will be displayed.

[!INCLUDE api-management-define-api-topics.md]

Next steps

[!div class="nextstepaction"] APIM policy samples Transform and protect a published API