zfcampus/zf-apigility-provider

Apigility interfaces

Installs: 145 473

Dependents: 5

Stars: 2

Watchers: 4

Forks: 3

Open Issues: 1

Language: PHP

1.1.0 2015-07-15 15:55 UTC

README

Build Status

Introduction

This repository consists of interfaces used by Apigility that can be composed into standalone modules and libraries so that consumers may choose to opt-in to Apigility functionality.

General Usage

To mark a module as being an Apigility-enabled module, add the following interface to your Module:

use ZF\Apigility\Provider\ApigilityProviderInterface;

class MyModule implements ApigilityProviderInterface
{
}

At this point, this particular module should show up in the Apigility UI interface.

Requirements

Please see the composer.json file.

Installation

Run the following composer command:

$ composer require "zfcampus/zf-apigility-provider:~1.0-dev"

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

"require": {
    "zfcampus/zf-apigility-provider": "~1.0-dev"
}

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 array(
    /* ... */
    'modules' => array(
        /* ... */
        'ZF\Apigility\Provider',
    ),
    /* ... */
);