The WSO2 API Manager 1.6.0 Released!

The WSO2 API Manager team is pleased to announce the release of version 1.6.0 of the Open Source API Manager.

WSO2 API Manager is a platform for creating, managing, consuming and monitoring APIs. It employs proven SOA best practices to solve a wide range of API management challenges such as API provisioning, API governance, API security and API monitoring. It combines some of the most powerful and mature components of the WSO2's state-of-the-art Carbon platform to deliver a smooth and end-to-end API management experience while catering to both API publisher and API consumer requirements.

WSO2 API Manager is comprised of several modules.

  • API Provider: Define new APIs and manage them
  • API Store: Browse published APIs and subscribe to them
  • API Gateway: The underlying API runtime based on WSO2 ESB
  • API Key Manager: Performs Key Generation and Key Validation functionalities

WSO2 API Manager is developed on top of the revolutionary WSO2 Carbon platform (Middleware a' la carte), an OSGi based framework that provides seamless modularity to your SOA via componentization. This release also contains many new features and a range of optional components (add-ons) that can be installed to customize the behavior of the API Manager. Further, any existing features of the product which are not required in your environment can be easily removed using the underlying provisioning framework of Carbon. In brief, WSO2 API Manager can be fully customized and tailored to meet your exact API management needs.

For more information on WSO2 API Manager please visit http://wso2.com/products/api-manager. Also take a look at the online product documentation.

How to Run

  1. Extract the downloaded zip
  2. Go to the bin directory in the extracted folder
  3. Run the wso2server.sh or wso2server.bat as appropriate
  4. Launch a web browser and navigate to https://localhost:9443/publisher to access the API provider webapp
  5. Navigate to https://localhost:9443/store to access the API store
  6. Use "admin", "admin" as the username and password to login as an admin
  7. If you need to start the OSGi console with the server use the property -DosgiConsole when starting the server. The INSTALL.txt file found on the installation directory will give you a comprehensive set of options and properties that can be passed into the startup script

New Features of WSO2 API Manager 1.6.0

This release of API Manager comes with several new features and bug fixes.

New Features

  • Workflow Extensions
  • Support for multiple backend endpoint types
  • Response Caching Support for APIs
  • Social Integration of API Portal
  • Hybrid API Store support (Super Tenant/Tenant Stores, subscription Control)
  • API Tracing

Bug Fixes

  • [APIMANAGER-1498] - Append additional CORS headers comes from the endpoint without overriding
  • [APIMANAGER-1561] - Application does not display any message , while trying to sign in using the inactive tenant details and exception thrown
  • [APIMANAGER-1721] - Token mgt SQL error with Oracle in Publisher node
  • [APIMANAGER-1746] - APIs does not getting listed in the store, when <DisplayAllAPIs> is set to true in api-manager.xml
  • [APIMANAGER-1760] - When an API is copied for an existing version, it doesnt give a validation message. It stays on the same screen
  • [APIMANAGER-1798] - When a tenant user logged in to the store and clicks on the Super Tenant Store link, tenant user's tags will be displayed
  • [APIMANAGER-1811] - ERROR - JDBCPersistenceManager Error when creating the Trusted IdP metadata store
  • [APIMANAGER-1820] - null creating a new API
  • [APIMANAGER-1826] - Created Token not appearing on My Subscriptions
  • [APIMANAGER-1827] - In the tenant mode, URL of 'Visit Publisher Store' in external stores is not computed correctly.
  • [APIMANAGER-1828] - Gateway key-cache does not get invalidated with revoke token api call and refresh_token api call
  • [APIMANAGER-1829] - Roles not appearing on JWT for tenant users
  • [APIMANAGER-1835] - If creating the 'subscriber' role failed during APIM server startup,login to publisher/store with users will be failed.
  • [APIMANAGER-1838] - Response caching at API Gateway level.
  • [APIMANAGER-1839] - Issues in Endpoint Address validation
  • [APIMANAGER-1840] - API creation fails with some wsdls
  • [APIMANAGER-1841] - API Update fail with a WSDL
  • [APIMANAGER-1843] - "ERROR - CacheMediatorFactory Unable to load the hash generator class" when publishing an api with caching enabled
  • [APIMANAGER-1844] - Why "Sandbox Endpoint:" is a mandatory field for URL end points
  • [APIMANAGER-1845] - Values provided in "Advance Endpoint Configuration" are not saved
  • [APIMANAGER-1846] - Production URL is not shown in API overview
  • [APIMANAGER-1847] - Error when creating an API with a WSDL
  • [APIMANAGER-1851] - OPTIONS call throws errors for some backend services when response caching is enabled
  • [APIMANAGER-1852] - Statistics not working.
  • [APIMANAGER-1853] - Error when publishing an api with load balnaced end points and having "round robin" as Algorithm
  • [APIMANAGER-1854] - Failover endpoint is not correctly shown in api edit mode
  • [APIMANAGER-1855] - It takes about 5mins to show a published API in the store in distributed setup
  • [APIMANAGER-1856] - [Store] [API Overview - Share] Email link does not respond
  • [APIMANAGER-1860] - Cannot start API-M 1.6.0 with -Dprofile=api-publisher
  • [APIMANAGER-1861] - API-M startup fails with -Dprofile=api-store
  • [APIMANAGER-1863] - Doc is not clear enough on how to start API-M pack with profiles
  • [APIMANAGER-1866] - Exception "Axis Module not found for : wso2statistics-4.2.2" when started with 'gateway-worker' profile
  • [APIMANAGER-1867] - secured endpoint template is not created
  • [APIMANAGER-1869] - Sharing API's on social networks feature doesn't work with Facebook and google+
  • [APIMANAGER-1871] - Key Validation doesn't work with WSClient mode
  • [APIMANAGER-1876] - " Endpoint Security Scheme" option becomes available only after saving the apis
  • [APIMANAGER-1877] - Cache mediator is not applied when enabling response caching
  • [APIMANAGER-1878] - In Load balanced endpoints, if the algorithm is "Other" (if a user wants to specify a custom algorithm) there's no way to mention the class name
  • [APIMANAGER-1880] - CNF issue when generating tokens with EncryptPersistedTokens enabled
  • [APIMANAGER-1882] - Error publishing the api is wadl is specified
  • [APIMANAGER-1884] - [UI] Endpoints labels in create API wizard in publisher is wrong
  • [APIMANAGER-1888] - Error when creating an API with a WSDL for user's who do not have admin permission
  • [APIMANAGER-1889] - WSDL URL not shown in API Store
  • [APIMANAGER-1891] - [QoS - Advance endpoint configuration] When you select WS-Security there's no way to specify the policy key
  • [APIMANAGER-1892] - [QoS - Advanced endpoint configuration] If WS-Addressing is selected, its better if we can specify Separate Listener option
  • [APIMANAGER-1893] - Minor UI issue in advanced endpoint configuraion
  • [APIMANAGER-1894] - Error while publishing the api when endpoint is secured
  • [APIMANAGER-1896] - Error when publishing api having load balanced endpoints
  • [APIMANAGER-1897] - Some API invocation fails when a API is subscribed by 2 user tokens.
  • [APIMANAGER-1903] - APIM advance endpoint config conection timeout should be drop down.
  • [APIMANAGER-1904] - [store] WSDL permalink exposes the publisher IP and port, instead it should give the gateway hostname
  • [APIMANAGER-1910] - [Failover endpoint] When production endpoint is down, api invocation fails
  • [APIMANAGER-1911] - [intermittent] Token regeneration feature does not work
  • [APIMANAGER-1913] - Error when saving G/W source view - java.lang.NoClassDefFoundError: org/wso2/carbon/proxyadmin/observer/ProxyServiceParameterObserver
  • [APIMANAGER-1914] - Gateway key-cache does not get clear with revoke token api call
  • [APIMANAGER-1918] - Response Caching get busted while running load test
  • [APIMANAGER-1923] - [Tenant mode] Login to store attempts fails several times and published apis are not shown
  • [APIMANAGER-1924] - [Tenant mode] Publisher broken if newly created tenant first login to store and then login to publisher
  • [APIMANAGER-1930] - Null error thrown when deleting apis if life cycle state is changed
  • [APIMANAGER-1944] - Error when creating api [having both image and wsdl]
  • [APIMANAGER-1946] - Update the workflow descriptions showing in workflow UI with proper grammar
  • [APIMANAGER-1949] - Workflow jaggery app login not working for tenant admin
  • [APIMANAGER-1955] - NPE when tenant clean up in Gateway nodes
  • [APIMANAGER-1373] - Implement secure vault for secured backend endpoint configuration

Improvements

All resolved issues

Key Features of WSO2 API Manager

Following is a categorization of the core features supported by WSO2 API Manager based on the target user group.

  • Create a Store of all Available APIs:
    • Graphical experience similar to Android Marketplace or Apple App Store.
    • Browse APIs by provider, tags or name.
    • Self-registration to developer community to subscribe to APIs.
    • Subscribe to APIs and manage subscriptions on per-application basis.
    • Subscriptions can be at different service tiers based on expected usage levels.
    • Role based access to API Store; manage public and private APIs.
    • Manage subscriptions at a per-developer level.
    • Browse API documentation, download helpers for easy consumption.
    • Comment on and rate APIs.
    • Forum for discussing API usage issues (Available soon in future version).
    • Try APIs directly on the store front.
    • Internationalization (i18n) support.
  • Publishing and Governing API Use:
    • Publish APIs to external consumers and partners, as well as internal users.
    • Supports publishing multiple protocols including SOAP, REST, JSON and XML style services as APIs.
    • Manage API versions and deployment status by version.
    • Govern the API lifecycle (publish, deprecate, retire).
    • Attach documentation (files, external URLs) to APIs.
    • Apply Security policies to APIs (authentication, authorization).
    • Associate API available to system defined service tiers.
    • Provision and Manage API keys.
    • Track consumers per API.
    • One-click deployment to API Gateway for immediate publishing.
  • Route API Traffic:
    • Supports API authentication with OAuth2.
    • Extremely high performance pass-through message routing with sub-millisecond latency.
    • Enforce rate limiting and throttling policies for APIs by consumer.
    • Horizontally scalable with easy deployment into cluster using proven routing infrastructure.
    • Scales to millions of developers/users.
    • Capture all statistics and push to pluggable analytics system.
    • Configure API routing policies with capabilities of WSO2 Enterprise Service Bus.
    • Powered by WSO2 Enterprise Service Bus.
  • Manage Developer Community:
    • Self-sign up for API consumption.
    • Manage user account including password reset.
    • Developer interaction with APIs via comments and ratings.
    • Support for developer communication via forums (Available soon in future version).
    • Powered by WSO2 Identity Server.
  • Govern Complete API Lifecycle:
    • Manage API lifecycle from cradle to grave: create, publish, block, deprecate and retire.
    • Publish both production and sandbox keys for APIs to enable easy developer testing.
    • Publish APIs to partner networks such as ProgrammableWeb (Available soon in future version).
    • Powered by WSO2 Governance Registry.
  • Monitor API Usage and Performance:
    • All API usage published to pluggable analytics framework.
    • Out of the box support for WSO2 Business Activity Monitor and Google Analytics.
    • View metrics by user, API and more.
    • Customized reporting via plugging reporting engines.
    • Monitor SLA compliance.
    • Powered by WSO2 Business Activity Monitor.
  • Pluggable, Extensible and Themeable:
    • All components are highly customizable thru styling, theming and open source code.
    • Storefront implemented with Jaggery (jaggeryjs.org) for easy customization.
    • Pluggable to third party analytics systems and billing systems (Available soon in future version).
    • Pluggable to existing user stores including via JDBC and LDAP.
    • Components usable separately - storefront can be used to front APIs gatewayed via third party gateways such as Intel Expressway Service Gateway.
    • Support for Single Sign On (SSO) using SAML 2.0 for easy integration with existing web apps
  • Easily Deployable in Enterprise Setting:
    • Role based access control for managing users and their authorization levels.
    • Store front can be deployed in DMZ for external access with Publisher inside the firewall for private control.
    • Different user stores for developer focused store-front and internal operations in publisher.
    • Integrates with enterprise identity systems including LDAP and Microsoft Active Directory.
    • Gateway can be deployed in DMZ with controlled access to WSO2 Identity Server (for authentication/authorization) and governance database behind firewall.
  • Support for creating multi-tenanted APIs
    • Run a single instance and provide API Management to multiple customers
    • Share APIs between different departments in a large enterprise
  • Publishing and Governing API Use
    • Document an API using Swagger
    • Restrict API Access tokens to domains/IPs
    • Ability to block a subscription and restricting a complete application
    • Ability to revoke access tokens
    • Separate validity period configuration for Application Access Token
    • OAuth2 Authorization Code Grant Type Support
    • Configuring execution point of mediation extensions
  • Monitor API Usage and Performance
    • Improved dashboard for monitoring usage statistics (Filtering data for a date range, More visually appealing widgets)

Known Issues

All the open issues pertaining to WSO2 API Manager are reported at the following location:

How You Can Contribute

Mailing Lists

Join our mailing list and correspond with the developers directly.

Reporting Issues

We encourage you to report issues, documentation faults and feature requests regarding WSO2 API Manager through the public API Manager JIRA. You can use the Carbon JIRA to report any issues related to the Carbon base framework or associated Carbon components.

Support

We are committed to ensuring that your enterprise middleware deployment is completely supported from evaluation to production. Our unique approach ensures that all support leverages our open development methodology and is provided by the very same engineers who build the technology.

For more details and to take advantage of this unique opportunity please visit http://wso2.com/support.

To learn more about WSO2 API Manager and WSO2 support offerings please visit http://wso2.com/products/api-manager.

-- The WSO2 API Manager Team --