Axway API Manager 7.6.2 Release Notes

Document version: 14 December 2018

Summary

API Manager is a licensed product running on top of API Gateway, and has the same deployment options as API Gateway: software installation, or virtualized deployment in Docker containers. For more information on API Gateway, see the API Gateway Release Notes.

The software installation is available on UNIX/Linux. For more details on supported platforms for software installation, see System requirements in the API Gateway Installation Guide.

Docker deployment is supported on UNIX/Linux. For a summary of the system requirements for a Docker deployment, see System requirements in the API Gateway Installation Guide, and for more details see What you need before you start in the API Gateway Container Deployment Guide.

New features and enhancements

The following new features and enhancements are available in this release.

Elastic topology container deployment

The new elastic topology container deployment architecture brings flexibility to capacity planning.

  • Deploy API Manager in Docker containers and use Kubernetes for container orchestration.
  • Easily scale the capacity of your environment up or down to respond to changes in load.
  • Auto healing to quickly start a new instance in case of a failure.
  • Choose the deployment architecture best suited to your needs: in addition to elastic topology, API Gateway7.6.2 also supports the classic deployment architecture that uses Node Managers.
  • Deploy configuration changes directly from Policy Studio to API Manager containers for development testing (supported in development environments only).
  • Redirect the trace and traffic logs to stdout instead of to separate files. This allows the logs to be read directly from each container by an external logging service.
  • Use Apache Cassandra as a distributed data store.

For more details, see the API Gateway Container Deployment Guide.

Global policy enforcement

This feature allows organizations and their governance teams to apply mandatory security, compliance, and governance policies, which are executed as part of every API call across their entire API portfolio. For more details, see Advanced API administration tasks in the API Manager User Guide.

Custom properties for APIs

API Manager has been enhanced to enable you to define custom properties for APIs, in the same way as you can define custom properties for applications, organizations, and users. For more information, see the API Manager User Guide.

Application credential alerts

The application credential alerts feature enables you to trigger alerts for any change to the credentials (API keys, OAuth credentials, or external credentials) associated with an application. For more information, see the API Manager User Guide.

Fault handling policies

This feature allows organizations and their governance teams to apply a fault handler policy at the global, API, and API method levels, so that it is executed when an error or exception occurs during runtime API invocation. For more information, see the API Manager User Guide.

API Manager configuration in Policy Studio

Use Policy Studio to easily configure API Manager instead of using the setup-apimanager script. For more details, see Enable API Manager in the API Manager User Guide.

Query-string based API versioning

In addition to the existing URL path based API versioning, API Manager now supports query string-based API versioning, giving flexibility in exposing API versions to API consumers.

  • Protect client applications invoking APIs from being impacted by minor and patch changes.
  • Use a global setting to define the query string variable name that specifies the API version that an application invokes.

For more details, see Advanced API administration tasks in the API Manager User Guide.

Method-level authorization

Method-level authorization increases the granularity in the access control for client applications.

  • Control which client application can access which method.
  • Restrict the number of applications authorized for write methods while still enabling the rest to access the read methods.

For more details, see Advanced API administration tasks in the API Manager User Guide.

Axway AMPLIFY menu

You can now connect to Axway services and Axway AMPLIFY platform straight from the API Manager UI. For more details, see Axway AMPLIFY™ Platform.

Limitations of this release

This release has the following limitations.

Elastic topology container deployment

When using an elastic container deployment:

  • Traffic monitor data for a specific API Manager instance does not persist in the event of that instance container stopping. However, you can redirect the trace and traffic logs to stdout instead of to separate files, which allows the logs to be read directly from each container by an external logging service.
  • Distributed Ehcache is not supported. However, you can use Apache Cassandra as a distributed data store.
  • To upgrade from an earlier version to 7.6.2, you must first upgrade to a 7.6.2 classic deployment and then migrate to an elastic container deployment.

For more details, see the API Gateway Container Deployment Guide.

Other deployment options

This release is not available as a virtual appliance, or as a managed service on Axway Cloud.

Removed features

In our efforts to continually upgrade our products in response to the needs of our customers’ IT environments, Axway occasionally discontinues support for some capabilities. API Manager 7.5.3 is the last release that includes the following capabilities, which have been removed from the 7.6.2 release:

  • Axway physical appliance deployment option.
  • API Manager on Windows servers. Only the following developer tools are available on Windows:
    • Policy Studio
    • Configuration Studio
    • Package and Deployment Tools

Fixed issues

API Manager 7.6.2 includes all fixes for 7.5.3 Service Packs up to and including 7.5.3 SP 7. For details of all the Service Pack fixes included in 7.6.2, see the corresponding SP Readme attached to each Service Pack on Axway Support at https://support.axway.com.

Known issues

The following are known issues for this release of API Manager.

Documentation might contain references to removed features

Documentation might contain references to removed features (for example, hardware or virtual appliances, or Windows support). This does not mean that the removed features are still supported, and the references should be ignored.

Cassandra synchronization in multi-datacenter environments

In multi-datacenter environments with Cassandra read/write consistency set to local quorum, there is a small risk of configuration corruption if the event triggering API Manager to load a configuration change happens before the configuration replication to the other datacenter is complete. Changing the polling time as described in Configure API Management in multiple datacenters in the API Gateway Installation Guide reduces this risk, but does not remove it completely.

This issue results in outdated configuration data being used for the affected API until API Gateway is restarted. For example, as a result of this, valid traffic may be rejected if a new API has been added and not updated, or wrong traffic may be accepted if an API has been deprecated and not updated. The workaround requires a restart of all API Gateway instances in the affected datacenter.

Axway is working on a product change that will avoid restarting API Gateway in such situations, and recommends to:

  • Wait for the resolution before going live with multiple datacenters and local quorum consistency.
  • If this is not possible, monitor your production environment closely for this error, and restart API Gateway if the error is encountered.

RAML import does not support references to external files

Importing RAML version 0.8 or RAML version 1.0 files that include references to external files is currently not supported.

Related issues: RDAPI-10356

Upgrade from API Manager 7.3.0 not supported

Upgrading API Manager version 7.3.0 to version 7.6.2 is not supported.

Related issues: RDAPI-5136, RDAPI-8237

API Manager users cannot complete registration after upgrading from 7.3.1

New users that were registered in API Manager 7.3.1 before an upgrade, but who did not complete registration by activating their account with the link provided in email, cannot complete registration after the upgrade. The link in the email references the API Manager API v1.1 that is no longer available. For example:

https://<API Gateway IP address>/api/portal/v1.1/users/validateuser?email=s@s.com&validator=9a5addcb-e10c-499b-bf0a-0c70915f3862

The workaround is that the user copies the link address, pastes it to the address bar, and changes the API version v1.1 to v1.2 or v1.3. After this, the activation link works, and the user can complete registration.

This issue does not occur when upgrading from API Manager 7.4.0 or later.

Related issues: RDAPI-3417

API Manager removes trailing slashes from the paths of APIs created from a Swagger definition file

When a back-end API is created from a Swagger definition file that contains trailing slashes in the path, API Manager removes the trailing slashes from the paths. Furthermore, when a request comes in with a trailing slash, API Manager returns HTTP error 403 bad request because it does not match the requested path.

To preserve the trailing forward slashes, edit the jvm.xml file and set the com.vordel.apimanager.uri.path.trailingSlash.preserve system property to true. After updating the file, restart the API Manager instance to enable the changes to be applied.

For example:

<VMArg name="-Dcom.vordel.apimanager.uri.path.trailingSlash.preserve=true"/>

The default value of the property is false.

Related issues: RDAPI-9243

Unsupported Swagger 2.0 elements

When registering a back-end API from a Swagger 2.0 definition, API Manager does not support the following elements and does not import them into the API Catalog:

  • title
  • termsOfService
  • contact
  • license
  • tags
  • securityDefinitions
  • externalDocs

For each path/API method:

  • tags
  • security
  • For each parameter:
    • default
    • maximum
    • exclusiveMaximum
    • minimum
    • exclusiveMinimum
    • maxLength
    • minLength
    • pattern
    • allowEmptyValue
    • collectionFormat
    • maxItems
    • minItems
    • uniqueItems
    • enum
    • multipleOf
  • For each response code:
    • headers
Note   Some of these elements are also used in the model definitions section in the Swagger 2.0 specification, and API Manager imports these elements when contained in that section. API Manager supports all elements in the Swagger model definitions section.

Supported Swagger 2.0 elements

The following elements are supported and imported into the API Catalog:

  • description
  • version
  • host
  • schemes
  • basePath
  • Global parameter
  • produces
  • Model definitions

For each path/API:

  • Path
  • HTTP method
  • Path parameter and reference to global parameter
  • For each method:
    • operationId
    • summary
    • description
    • consumes
    • produces
  • For each parameter:
    • name
    • in
    • description
    • required
    • type
    • schema
    • format
    • Reference to global or path parameter
  • For each response code:
    • Response code
    • description
    • schema

Documentation

You can find the latest information and up-to-date user guides at the Axway Documentation portal at https://docs.axway.com.

This section describes documentation enhancements and related documentation.

Documentation enhancements

See What's new in documentation for a summary of the documentation changes in this release.

The AMPLIFY API Management solution enables you to create, publish, promote, and manage Application Programming Interfaces (APIs) in a secure and scalable environment. For more information, see the AMPLIFY API Management Getting Started Guide.

The following reference documents are also available:

  • Supported Platforms
  • Lists the different operating systems, databases, browsers, and thick client platforms supported by each Axway product.
  • Interoperability Matrix
  • Provides product version and interoperability information for Axway products.

Support services

The Axway Global Support team provides worldwide 24 x 7 support for customers with active support agreements.

Email support@axway.com or visit Axway Support at https://support.axway.com.

See Get help with API Gateway in the API Gateway Administrator Guide for the information that you should be prepared to provide when you contact Axway Support.

Related Links