Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Your Org must have a subscription to the API Management feature; otherwise, the API Management UI is not enabled.

  • You must have Write permissions to create an API.

  • To create API version using Git, you need to be a Git-authenticated user.

API Manager

You can navigate to the API Manager console by clicking Manager > API Management > API Manager.

...

  1. Navigate to API Management > API Manager, and click the target API to display the API Details page.

  2. Click the Versions tab, then click Image Removed(blue star)  to display the Create Version dialog window.

  3. In the Create API version dialog window, select Create from Existing Project, then click Continue:

  4. In the Create API Version-Select Assets dialog window, select/deselect the assets from the Project to use in the API Version, then click Import and Continue.
    An Asset selected at the root level also imports the leaf-level Assets.

  5. Enter information about your API Version, then click Create.Image Removed

    • General Info: Provide basic information about your API. The name is the API name plus the version number.

      • Description: Enter a brief description.

      • Version: Define the version. By default, the version is 1.0 when you create an API for the first time.

      • Tags: Enter any tags associated with your API.

    • Endpoint Configuration: The base path for the endpoint.

    • Server Configuration: Enter the Snaplex associated with this API.

    You must enter a name and Snaplex. You can also change the version from this dialog window, and therefore create another version of the API.

    After you create a version of an API, the Version asset is displayed on the Versions Details page. You can view information about the assets used in the API version by clicking it.

...

  1. Navigate to API Management > API Manager, and click the target API to display the API Details page.

  2. Click the Versions tab, then click Image Removed(blue star)  to display the Create Version dialog window.

    Image Modified

  3. In the Create API version dialog window, select Create Empty API Version click Continue.
    Image Removed

  4. Enter information about your Version, then click Create.

    • General Info: Provide basic information about your API. The name is the API name plus the version number.

      • Description: Enter a brief description.

      • Version: Define the version. By default, the version is 1.0 when you create an API for the first time.

      • Tags: Enter any tags associated with your API.

    • Endpoint Configuration: The base path for the endpoint.

    • Server Configuration: Enter the Snaplex associated with this API.

    You must enter a name and Snaplex. You can also change the version from this dialog window, and therefore create another version of the API.
    Image Removed

    After you create a version of an API, the Version asset is displayed on the Versions Details page. You can view information about the assets used in the API version by clicking it.

Create the API version from a Git repository

You can create the API version from the Git repository as shown below:

  1. In the API Manager page, click on the API:

    git-op-apiversion-apimanager-accepted.pngImage Added

  2. Click on the Versions tab:

    git-op-apiversion-version.pngImage Added

     

  3. Click on the the add icon ( (blue star) ) and a pop-up wizard Create API version is displayed:

    git-op-apiversion-version-add.pngImage Added

     

  4. In Create API version wizard, select Create from Git Checkout:

    git-op-apiversion-git-checkout.pngImage Added

     

  5. Choose the Git Repository from field Repository and choose the branch from the field Branches/Tags:

    git-op-apiversion-git-repo-branch.pngImage Added

     

  6. Click Continue and enter in the rest of the details, then click Create:

    git-op-apiversion-gi-details.pngImage Added

     

  7. Your API version is created from Git Repository:

    git-op-apiversion-version-created.pngImage Added

     

Edit API Version

You can edit the API Version with the below steps:

...

  1. Navigate to API Management > API Manager, click the target API to display the API details page.

  2. Click the Versions tab and point your cursor on the target Version.
    The delete icon is displayed.Image Removed

  3. Click Image Removed(blue star)  to delete the API Version, then click Delete on the confirmation prompt.
    Image Removed

The API Version is deleted from the API Manager console.