Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: APIM-1272

...

This deployment would offer the flexibility of using Cloud services for your Self-managed Snaplex nodes and some of the performance optimization of the second deployment architecture. Load balancers would route traffic to the Snaplex nodes in front of the firewall to run API policies. The Snaplex nodes behind the firewall would process the API requests.

Best Practices for Migrating API Assets between Orgs/Environments

A common scenario for customer organizations is to have a development for creating and testing APIs and a separate production Org/Environment. This setup requires the migration of assets when your APIs are ready to be shared with your audiences for consumption.

We recommend that you API Management public APIs to automate these types of API migrations. You have the following options to do this:

  1. Use the Migrate an API Version Public API to migrate all your APIM assets in a version, including the policies from the source Org/Environment to the destination Org/Environment.

  2. As an alternative, you can move the APIs to the destination Org/Environment with the Export and Import an API version Public APIs. This option will export the assets to a zip format you can download from the source Org/Environment to your local environment. You can then upload the API version and its assets as one zip file to the destination Org/Environment.

General API Development Best Practices

Naming Endpoints

  • Use nouns instead of verbs for URI endpoints.

  • Pluralize all resources.

  • Use a comma to punctuate lists.

  • Enable query parameters to sort or filter information.

  • No special characters

  • Use lowercase

  • No abridgments

  • Avoid jargon; use intuitive terms.

  • Do not add a trailing forward slash to your URI

  • Do not use file extensions