Completed

API Migration

Avatar
Shabnam Shaikh

Hi,

Could you please provide the steps for API migration and suggest the best practices involved?

We attempted the following scenario to migrate an API:

We exported an API from the SB environment and tried importing it into the PROD environment using the "Import an API" option. However, we encountered the following issue.

image

0

Comments

2 comments
Date Votes
  • Avatar
    Kaustav Roy

    Hi Shabnam, 

    After exporting the API, few values in the JSON needs to be updated from the old environment (sandbox) to the new environment (production). 

    1. “proxy” > “vistual_hosts” > “hosts” (see screenshot), which should resolve the error on upload. 
    2. “pages” > “content”, which should correctly update the OpenAPI spec
    3. Also, the “proxy” > “groups” > “endpoints” > “target” should be updated with the new backend service URL in IO (in production).

    Note that this approach can be taken when there has been lot of updates (e.g. policies, etc.) made in APIM console, and you do not want to do that again for the new environment. But since it's manual it can be error prone, and the integration between IO and APIM is not maintained.

    The recommended approach is to create the API services (clone/copy) in the new environment in IO, and then push them to APIM console (new environment). This way, the above manual steps are automatically taken care of. You will just need to make any updates you had made in sandbox APIM, in this approach.

    Thanks,

    Kaustav

    0
  • Avatar
    Shabnam Shaikh

    Hi Kaustav Roy ,

    Thanks for your response. We followed the above steps and the API was migrated successfully. 

    0

Please sign in to leave a comment.

 

Didn't find what you were looking for?

New post