This page contains release notes for all versions of the Apinizer platform published in 2021. For each version, new features, changes, fixes, and migration notes are listed in detail.
In 2021, the Apinizer platform was developed with important updates and new features. All changes made during this year are listed below.
The first version of Apinizer API Developer Portal was released! API Portal is an important communication channel for APIs, serving as a bridge between API Provider and API Consumer. API Provider defines the API Proxies it wants to expose to the outside world from the Apinizer Manager Console. API Consumer also manages how to communicate with an API through the Apinizer API Developer Portal. The goal is to enable API Provider to easily share API Proxies and enable their consumption. Additionally, Apinizer provides design customization on API Developer Portal, access to and testing of API Catalog and API Documentation, Terms & Conditions definition, API analytics, API traffic monitoring, account management, credential management, and access control capabilities based on API and Credential.
API can be created from API Proxy through the management section by the API Developer Portal Administrator. Thus, external sources can access through the environment assigned to the API Proxy. Additionally, Portal Administrator manages API accessibility from here.
Accounts that can log into the API Developer Portal, whether they are organization managers or not, are defined by the API Developer Portal Administrator. An account that is an organization manager has the authority to create other accounts belonging to its sub-organizations. The account can manage APIs assigned to it or assign them to another account. Each account determines its own credentials for sending requests to the API. Additionally, access control based on credential for API or credential access restriction based on API can be made.
Customization, email management, terms & conditions, and integration operations that are valid throughout the portal are configured by the API Developer Portal Administrator.IMPORTANT CHANGES AND IMPROVEMENTS
Application logs belonging to Worker can now be monitored through the Application Logs tab on the API Proxy screen.
Management of historical information for Credential and API to be used on Portal UI side was added to Audit Records.
CorrelationID filter was added to API Traffic screen.
BUG FIXESAPNZ-2593 : Credential relationship appears even though it was removed from contract.APNZ-2599 : Audit record is not kept for every object.APNZ-2601 : Credential in expired contract can make requests and does not give “Contract Expire Date ..vs” error.APNZ-2605 : WS-Security policy gives error.APNZ-2606 : Delete and filter operations on Application Logs screen do not work consistently.APNZ-2607 : Audit pages/tabs do not open.APNZ-2609 : Project filter in Credential’s ACL tab does not work. Same API Proxy can be added to credential multiple times.APNZ-2619 : When logging in, even though project is selected, it behaves as if it is not.APNZ-2624 : Error occurs when a parameter is used in multiple places in DB-2-API.APNZ-2638 : In JWT Authentication policy, even though the option to add user to header is active, no header added is seen in log.APNZ-2640 : Authentication token acquisition error does not appear in token logs.
With API Proxy Template that can be defined for each project, all API Proxies in that Project are created according to the specified template. Thus, definitions common to all or most API Proxies such as Cache, CORS, Authentication, Error Response Template, Forwarded IP Header Parameter, API Based Quota, and API Based Throttling can be made once, reducing the work of API Developers. Features coming with API Proxy Template can be changed for API Proxy if desired.
With Mock API Creator, Mock APIs that return predefined responses for requests can be created easily and quickly. These responses can be customized according to conditions. RESTful Mock APIs created in this way can be used for purposes such as prototyping or testing.IMPORTANT CHANGES AND IMPROVEMENTS
Parameter definition feature in list form was added to API Creator → DB-2-API module to support writing IN queries.
Cursor return value was added for Oracle database.
BUG FIXESAPNZ-2483: Elasticsearch authentication error.APNZ-2480: Parameters do not appear in sample messages created for Soap2Rest API Proxy.APNZ-2479: Conditions previously entered are lost in Mock API Reparse operation.APNZ-2477 : Error in Backend digest authentication policy.APNZ-2476 : There is an issue with missing definition creation for API Proxies in Privacy Manager.APNZ-2475 : In Privacy manager screen, if element name is empty, Save button should be disabled.APNZ-2472 : Error messages on Soap2Rest screen do not come.APNZ-2469 : Response is incorrect in Swagger and Open API Spec created for DB-2-API.APNZ-2457 : Newly added method to DB-2-API does not appear in API Spec.APNZ-2454 : API Developer role in project cannot delete API Proxy. API Manager role does not see global policies.APNZ-2453 : Null error occurs in Mail Connector if values like {{}} come in mail body.APNZ-2441 : OUT parameters belonging to Stored Procedure in DB-2-API appear as IN parameters in API Spec created for this DB-2-API.
All entities defined in a Project can be exported (export) for backup purposes or to create a new project with the same settings by importing (import).
API Proxy Groups enable managing and deploying multiple API Proxies as a group to configure Policies and control access. Access can be provided through the API Proxy Group’s URL by disabling the own URLs of API Proxies in the API Proxy Group.
Enables managing topics such as to whom, when, according to which contract/protocol API Proxies are opened, when the contract/protocol will end, and automatic closure of access to API Proxies accordingly.IMPORTANT CHANGES AND IMPROVEMENTS
Credentials in CSV format obtained and/or prepared from any system can now be easily loaded into the Apinizer identity pool.
Quick search capability was added through Name and Gateway Address fields when selecting API Proxy in Test Console.
Connection Pool structure was established for Elasticsearch and Routing for performance improvement of Worker servers.
apinizer-log-ilm-policy delete phase settings for Elasticsearch lifecycle were added in Elasticsearch configuration.
Capability to define usage purpose of API Proxies and filter API Proxies opened internally and/or externally to organization/company was added.
Capability to test API Proxy Groups in Test Console was added.
BUG FIXESAPNZ-2428 : Error occurs when clicking try button in DB-2-API and try button does not work.AC-2011 : “enable relative path” field in project cannot be disabled.AC-2209 : Old revision should appear when creating revision.AC-2213 : Name of test created in Test Console cannot be changed.AC-2334 : API Integration gives null error when disabled without creating server configuration.AC-2352 : When Swagger is imported and Spec is created on Spec API screen, server information does not come.AC-2372 : When Circuit Breaker and Client Flow Banner are enabled, some fields that should be required can be left empty.AC-2387 : Integration application does not send mail and gives dependency error when running in production mode.AC-2388 : In API Proxy created from DB-2-API, parameters of endpoint selected in Test Console do not come.AC-2391 : Privacy Management gives error on API Proxy Settings tab and list does not load.AC-2400 : If no project is selected, Connection Management menu appears on the left in project menu even though not authorized.AC-2410 : In Response Time graph in Analytics, if Total Time and Routing Time are the same, graph shows incorrectly.AC-2412 : When last 5 min is selected in Analytics Dashboard, some results are missing in graphs.
Capability to clone an API Proxy and thus create a new API Proxy with another name with the same settings was added. API Proxy clone is a very useful method especially for a new version of an API Proxy that is desired to be opened from a different address.
Single and Distributed options for Load Balancing were added in API Proxy Routing section.Single: Each Worker server keeps Routing information on itself for load balancing. Thus, a significant performance increase is achieved in Routing operations. However, it does not guarantee 100% compliance with the selected algorithm (Round Robin, LRU, Weighted, etc.) when distributing load among Worker servers.Distributed: Distributed cache is used during load balancing to decide which Worker server the request will be sent to. Thus, it guarantees 100% compliance with the selected algorithm (Round Robin, LRU, Weighted, etc.) when distributing load among Worker servers. However, its performance is worse than the Single option.
Empty API enables creating API Proxy for APIs/Web Services without API definition files. This way, code-first developed APIs can also be easily opened through Apinizer.
Test tools can be used to send requests to API/Web Services and see if they return a response or see the content of the returned response. This way, it is possible to quickly perform tests without leaving the Apinizer environment.
As test usage increases, using history may become difficult. It is possible to prepare Test Collections, group test definitions, and save them, thus making them more manageable.
If there are requests that received errors, they can be immediately repeated from within the interface showing log records. This way, without performing any search operation, the request that caused the error can be repeated directly, and testing can be done quickly and easily again.
A task was created that automatically deletes expired tokens stored in the database. Apinizer administrator can stop this task from Management → Scheduled Jobs menu if desired, or make it run again at any time.IMPORTANT CHANGES AND IMPROVEMENTS
Endpoint to be opened for relevant Task Flow in Task Flow screen comes passive by default, user can activate it if desired.
If SOAPAction header is not present in Soap1.1 service, SOAPAction described in WSDL is automatically added.
Error Message screen in Admin menu was fixed for easy definitions.
JDBC URL Template coming by default for database connectors was ensured.
Test Console and Test Tools were added to the top menu so they can be easily accessed from anywhere within the application.
When changes occur in global policies, capability to show all API Proxies using it on the same screen and redeploy was provided.
BUG FIXESAPNZ-2034 : Error comes in browser console when API Proxy list is fetched for Test Console.APNZ-2091 : When API Proxy creation type is KPS, REST to SOAP option does not come.APNZ-2111 : There are errors in the test part of LDAP Authentication Provider’s advanced settings section.APNZ-2114 : Errors occur when Integrator Environment is updated.APNZ-2121 : Parameters of body type do not appear in DB-2-API Spec file.APNZ-2021 : Email is sent even though Email action is disabled.APNZ-2096 : Errors occur on Heartbeat Monitor screen.APNZ-2136 : Null error is received in Service Access Address when only ’/’ is written in Apinizer rootcontext.APNZ-2138 : Runtime error occurs in Business Rule policy when “Condition is empty” is selected.APNZ-2150 : Error occurs when statusCode is entered in Script Policy screen.APNZ-2152 : Encoding error occurs when JSON data is sent in Query Parameter.APNZ-2148 : If error is received while testing Script policy, error message disappears before user can read it.APNZ-2154 : In API Proxy tabs on API Traffic, API Analytics, and Audit pages, information of other API Proxies also comes, not just the selected API Proxy, on first opening.APNZ-2156 : API Proxy gives error when data entry is made to only one of three fields in Policy Error Message formatting.APNZ-2202 : proxyTime, backendTime, and totalTime values in API Proxy’s Analytics tab show values of wrong fields.APNZ-2208 : Error occurs when adding Code to a response message in API Design.APNZ-2226 : Response is returned even if method/endpoint is disabled in API Proxy.