Laminas API Tools

Introduction

Meta-module for Laminas combining features from:

• api-tools-api-problem
• api-tools-content-negotiation
• api-tools-content-validation
• api-tools-hal
• api-tools-mvc-auth
• api-tools-rest
• api-tools-rpc
• api-tools-versioning

in order to provide a cohesive solution for exposing web-based APIs.

Also features database-connected REST resources.

Requirements

Please see the composer.json file.

Installation

Run the following composer command:

$ composer require laminas-api-tools/api-tools

Alternately, manually add the following to your composer.json, in the require section:

"require": {
    "laminas-api-tools/api-tools": "^1.3"
}

And then run composer update to ensure the module is installed.

Finally, add the module name to your project's config/application.config.php under the modules key:

return [
    /* ... */
    'modules' => [
        /* ... */
        'Laminas\ApiTools',
    ],
    /* ... */
];

laminas-component-installer

If you use laminas-component-installer, that plugin will install api-tools, and all modules it depends on, as a module in your application configuration for you.

Assets

If you are using this module along with the admin and/or the welcome screen, this module contains assets that you will need to make web accessible. For that, you have two options:

• rwoverdijk/assetmanager is a Laminas module that provides advanced capabilities around web asset management, and is the original tool used by this module. At its current release (1.6.0), however, it does not support v3 components from Laminas. An upcoming 1.7.0 release will likely support them.
• laminas-api-tools/api-tools-asset-manager is a Composer plugin that acts during installation and uninstallation of packages, copying and removing asset trees as defined using the configuration from rwoverdijk/assetmanager. To use this, however, you will need to install the plugin first, and then this module. (If you have already installed this module, remove it using composer remove laminas-api-tools/api-tools.)

Configuration

User Configuration

The top-level configuration key for user configuration of this module is api-tools.

db-connected

db-connected is an array of resources that can be built via the TableGatewayAbstractFactory and the DbConnectedResourceAbstractFactory when required to fulfill the use case of database table-driven resource use cases. The following example enumerates all of the required and optional configuration necessary to enable this.

Example:

'db-connected' => [
    /**
     * This is sample configuration for a DB-connected service.
     * Each such service requires an adapter, a hydrator, an entity, and a
     * collection.
     *
     * The TableGateway will be called "YourDBConnectedResource\Table" should
     * you wish to retrieve it manually later.
     */
    'YourDBConnectedResource' => [
        'table_service'    => 'Optional; if present, this service will be used as the table gateway',
        'resource_class'   => 'Optional; if present, this class will be used as the db-connected resource',
        'table_name'       => 'Name of DB table to use',
        'identifier_name'  => 'Optional; identifier field in table; defaults to table_name_id or id',
        'adapter_name'     => 'Service Name for DB adapter to use',
        'hydrator_name'    => 'Service Name for Hydrator to use',
        'entity_class'     => 'Name of entity class to which to hydrate',
        'collection_class' => 'Name of collection class which iterates entities; should be a Paginator extension',
    ],
],

System Configuration

The following configuration is required to ensure the proper functioning of this module in Laminas Framework applications, and is provided by the module:

namespace Laminas\ApiTools;

use Laminas\Db\Adapter\AdapterAbstractServiceFactory as DbAdapterAbstractServiceFactory;
use Laminas\ServiceManager\Factory\InvokableFactory;

return [
    'asset_manager' => [
        'resolver_configs' => [
            'paths' => [
                __DIR__ . '/../asset',
            ],
        ],
    ],
    'router' => [
        'routes' => [
            'api-tools' => [
                'type'  => 'literal',
                'options' => [
                    'route' => '/api-tools',
                ],
                'may_terminate' => false,
            ],
        ],
    ],
    'service_manager' => [
        'factories' => [
            MvcAuth\UnauthenticatedListener::class => InvokableFactory::class,
            MvcAuth\UnauthorizedListener::class => InvokableFactory::class,
        ],
        'abstract_factories' => [
            DbAdapterAbstractServiceFactory::class, // so that db-connected works "out-of-the-box"
            DbConnectedResourceAbstractFactory::class,
            TableGatewayAbstractFactory::class,
        ],
    ],
];

Laminas Events

Listeners

Laminas\ApiTools\MvcAuth\UnauthenticatedListener

This listener is attached to MvcAuthEvent::EVENT_AUTHENTICATION_POST at priority 100. The primary purpose fo this listener is to override the api-tools-mvc-auth unauthenticated listener in order to be able to respond with an API-Problem response (vs. a standard HTTP response) on authentication failure.

Laminas\ApiTools\MvcAuth\UnauthorizedListener

This listener is attached to MvcAuthEvent::EVENT_AUTHORIZATION_POST at priority 100. The primary purpose of this listener is to override the api-tools-mvc-auth unauthorized listener in order to be able to respond with an API-Problem response (vs a standard HTTP response) on authorization failure.

Laminas\ApiTools\Module

This listener is attached to MvcEvent::EVENT_RENDER at priority 400. Its purpose is to conditionally attach Laminas\ApiTools\ApiProblem\RenderErrorListener when an MvcEvent's result is a HalJsonModel or JsonModel, ensuring api-tools-api-problem can render a response in situations where a rendering error occurs.

Laminas Services

Factories

Laminas\ApiTools\DbConnectedResourceAbstractFactory

This factory uses the requested name in addition to the api-tools.db-connected configuration in order to produce Laminas\ApiTools\DbConnectedResource based resources.

Laminas\ApiTools\TableGatewayAbstractFactory

This factory uses the requested name in addition to the api-tools.db-connected configuration in order to produce correctly configured Laminas\Db\TableGateway\TableGateway instances. These instances of TableGateways are configured to use the proper HydratingResultSet and produce the configured entities with each row returned when iterated.

Models

Laminas\ApiTools\DbConnectedResource

This instance serves as the base class for database connected REST resource classes. This implementation is an extension of Laminas\ApiTools\Rest\AbstractResourceListener and can be routed to by Laminas API Tools as a RESTful resource.