Release Notes: API Developer Portal
These Release Notes summarize the new and enhanced features, known issues, resolved issues, and compatibility matrix for CA API Developer Portal 4.4.
Installer Script Has Been Updated to Pull from Docker Hub
[Issued on December 7, 2020] The API Developer Portal will no longer support Bintray and will instead rely on Docker Hub as its preferred distribution platform by the end of December 2020. As a result of this change, customers who install, reinstall or upgrade to any of the Layer7 API Developer 4.x versions with the installer script (portal.sh) will need to replace it with an updated one that ensures that images are being pulled from Docker Hub.
For API Developer Portal 4.4 installations, visit the Layer7 (CA) API Developer Portal Solutions & Patches page to download the updated installer shell script (portal.sh).
Note for customers using API Gateway 10 CR1
For customers using the API Portal with the Layer7 API Gateway, a sync issue exists that renders some Portal-published APIs incompatible with API Gateway version 10 CR1. As a temporary workaround, we recommend using other versions of the API Gateway (9.x or 10.0 base). In the case where an upgrade has been performed and a rollback is not possible, you can download and manually install an attached revised policy from Broadcom Support. See KB 199747: Compatibility with API Portal 4.x and API Gateway 10 CR1 for details.
New API Management Endpoints
A new set of API operation endpoints (labeled as
api-management/1.0/apisin Portal API (PAPI) 4.4) have been introduced that allow functionalities such as SOAP support, API visibility for Orgs, and granular permissions. These endpoints are accessible through the APIs page by default or manually through PAPI.
Note that earlier API endpoints (labeled as
/Apis) have been moved to the Deprecated section in PAPI 4.4 and will be removed in the next release. We recommend moving to the new endpoints to make full use of API Portal's current and future functionalities.
For more information, see Portal API (PAPI).
Assign APIs to Multiple Organizations
APIs can now be directly assigned to multiple organizations without being attached to an Account Plan. The visibility of APIs is no longer managed on the Account plan level. Only quota and a rate limit are defined on the Account Plan level. For more information, see Manage APIs.
Account Plans no longer control the visibility of APIs. If you have been using Account Plans for indirect API assignment, the organization mapping is updated.
Limit Visibility of APIs to Private, Public, and Restricted
Administrators can now manage the visibility and editing of APIs on the organization level. Admins assign which organizations have private, public, or restricted visibility of APIs and which organizations can manage specific APIs. For more information, see Manage APIs.
SOAP API Support
API Portal now supports publishing and management of SOAP-based APIs. A publisher can publish a SOAP API through Portal or Gateway for developers to discover and consume. For more information, see Manage APIs.
Create Multiple Tenants
Portal administrators can now create multiple Portal tenants in their domain, using the Tenant Provisioning Service (TPS) API. TPS is a standalone service responsible to perform all the activities required to manage the provisioning of tenants within the Portal via a REST API. For more information, see Portal Multi-Tenancy.
Improved Analytics Solution
Portal installation now deploys an internal Apache Druid analytics engine. For more information on the new analytics solution, see Monitor.
Use Helm Chart to Deploy API Portal on Your Kubernetes Cluster
API Portal can now be installed and deployed onto your existing Kubernetes cluster using an API Portal Helm chart. See Install Portal on Kubernetes for more information.
Test and Explore APIs using Swagger UI
Publishers can now access an API's OpenAPI specifications directly from the API Details page. Using the Swagger UI, test and explore the API's resources with improved rendering capabilities. For more information, see Test and Explore APIs.
Use Rich Text in Swagger Files
Conforming with OpenAPI Specification 3.0 (Swagger) standards, API Portal now supports CommonMark markdown, allowing you to include searchable rich text and media files in your API specifications. For more information, see Edit and Delete APIs.
Integrate with Runscope
You can now integrate with Runscope to create API monitoring tests from your API in
API Portal. Runscope is now part of the BlazeMeter Continuous Testing platform. API monitoring from
API Portalimproves the API lifecycle management. It also allows you to have better visibility into monitoring the performance of key uses cases of your APIs and allows you to quickly identify problems with your API.
API Portalinstallation now includes the
integration_runscopedatabases for the integration. The integration uses the databases only after you enable integrations. The
integration_coredatabase tracks the integrations in API Portal, such as the Runscope integration. The
integration_runscopedatabase is specific to the Runscope integration.
For more information, see Enable Integrations.