Apigility Version 1.0.0betaPre-release
This is the first beta release for Apigility. From this point forward, we will
be keeping backwards compatibility between versions. New features will be
targetted for version 1.1.0, with bugfixes and security fixes targetted for the
upcoming stable release and any subsequent maintenance releases.
All Apigility modules were updated to use a PSR-4
structure and autoloader. This flattens the packages significantly, and also
allows simplification of the PHPUnit test runner. A PSR-4 variant of the ZF2
ZF\Apigility\Autoloader, was created to provide true
PSR-4 autoloading, including the ability to have underscores (
_) in class
names, which has been a common feature request. ZF2
Module classes created for
new API modules now use the new autoloader for loading classes inside the
All modules were added to Travis-CI, giving us continuous integration going
With the release of Zend Framework 2.3.0, we were able to update the ZF2
dependency to remove the
-dev stability marker; this also means that packages
should start to be smaller, as we'll be able to use distribution versions of ZF2
going forward instead of git clones.
Additionally, the following features were added:
zfcampus/zf-content-validation#8 adds the ability to provide HTTP method-specific input
filters. This feature is not yet integrated into the Apigility Admin UI, but
can be configured manually. To do so, add method/input filter service name
pairs for the given controller service name; if no method-specific input
filter exists, zf-content-validation will fallback to the
if defined. As an example:
'zf-content-validation' => array(
'Example\V1\Rest\Status\Controller' => array(
// This is the fallback input filter, and the one the UI
// can define and manipulate:
'input_filter' => 'Example\V1\Rest\Status\Validator',
// This one will be used on POST requests only:
'POST' => 'Example\V1\Rest\Status\NewStatusValidator',
provides a patch that injects the
MvcEventwith a new key,
ZF\MvcAuth\Identity. You can pull the discovered identity from this event
parameter now. Additionally, in REST resources, calling
will retrieve the identity.
provide initial input filters for all Apigility Admin API services, as well as
UI integration for reporting errors. All validation errors are caught and
reported in a single dialog within the form that raises them.
The 'edit settings' screen for REST services now allows editing the entity
class and collection class names.
The 'API Overview' page now links services to their overviews. The service
description is displayed beneath each service; if not yet defined, a link to
the 'edit documentation' tab for the service is provided.
A new modal will be displayed to users of the Apigility Admin UI if the API
detects that the filesystem is not writable. The modal details what changes
need to be made in order for the UI and API to work correctly.
out initialization of the
oauth2-server-phpserver from the
controller, allowing the ability to replace it, write a delegator for it, etc.
changes the key used by the
input_filter_specs. This is due to the fact that ZF 2.3.0
InputFilterManager, which is already consuming the key
input_filters. Wrapped in this change is the fact that the
InputFilterAbstractServiceFactoryis now registered as an abstract service
factory with the
InputFilterManager, instead of with the application service
For those updating their Apigility libraries to 1.0.0beta1, edit your
module.config.phpfiles to rename the
ZF\Configuration\Controllerwas moved into
zf-apigility-admin. This URI for the service remains the same, but the
controller itself has moved. (This change was done to consolidate all Admin
API controllers in the same module, as well as to reduce the dependencies
needed in the
zfcampus/zf-apigility-admin#115 - Ensures
that non-SQLite PDO OAuth2 adapters may be provided without error.
zfcampus/zf-apigility-admin#117 - Ensure
route_matchis passed to the API when saving an RPC service.
zfcampus/zf-apigility-admin#118 - Ensure
that the Content Negotiation
selectoris passed to the API correctly when
saving an RPC service.
zfcampus/zf-apigility-admin#120 - Remove
duplicate call to initialize the
zfcampus/zf-apigility-admin#123 - Add checks
for array keys before accessing them when building the documentation graph for
a given service operation.
zfcampus/zf-apigility-admin#126 - Updates
the admin to pass the
X-UA-Compatiblemeta tag in order to provide Internet
zfcampus/zf-apigility-admin#132 - Ensures
that authorization data is fetched each time a new service is created, a
service is updated, or a service is deleted, ensuring the table reflects the
current list of available services and HTTP methods.
zfcampus/zf-apigility-admin#133 - Updates
the 'angular-flash' functionality to anchor flash messages to the bottom of
the window. Additionally, any error flash messages now have a 'close' button,
requiring user intervention for dismissal.
Many fixes were made to the UI to improve performance, remove UI refresh
errors, provide more consistent color schemes, ensure tabs stay focussed
between state transitions, etc.
The Apigility Admin API was updated to break the authentication service into
more granular sub-services, one for each type of authentication supported.
This simplifies validation, and allows for future expansion.
Work was done to ensure opcode cache detection is as solid as possible. We now
properly distinguish between APC and APCu, allowing the latter to be enabled
when using the Admin API.
zf-apigility-documentationwas not correctly aggregating RPC documentation;
this has been fixed.
We reviewed the various events triggered to ensure that they were happening in
the correct order, which we defined as:
- HTTP method negotiation (is the method called allowed for the service?)
- Authorization (is the discovered identity allowed to perform the requested
- Content Negotiation (determine incoming Content-Type and marshal data from
request body; determine if Accept and/or Content-Type are valid for the
- Content Validation
Several event listener priorities were updated to fit the above requirements.
A new listener,
ZF\Rest\Listener\OptionsListener, was introduced to handle
HTTP method negotiation for REST services, and is registered at the same
priority as the RPC
OptionsListener(which previously existed).
zf-configurationwas updated to never write configuration using short-array
notation; this was done to ensure compatibility of generated configuration
with PHP 5.3 (as developers may use the admin API via 5.4, but deploy to 5.3).