Edit an API

  • Article

APPLIES TO: All API Management tiers

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

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

Prerequisites

Go to your API Management instance

  1. In the Azure portal, search for and select API Management services.

    Select API Management services

  2. On the API Management services page, select your API Management instance.

    Select your API Management instance

Edit an operation

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

  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 backend 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.

Next steps

APIM policy samples Transform and protect a published API