API Blueprint integration for Apigility
Switch branches/tags
Nothing to show
Clone or download
Latest commit c115ddc May 7, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
docs Results of running `zf-maintainer rebase-doc-templates` May 7, 2018
src
test
view/zf-apigility-documentation-blueprint kick-off of API Blueprint module for apigility Jun 11, 2015
.coveralls.yml Results of running `zf-maintainer rebase-doc-templates` May 7, 2018
.gitattributes Results of running `zf-maintainer rebase-doc-templates` May 7, 2018
.gitignore
.travis.yml Updated Travis CI configuration May 7, 2018
CHANGELOG.md Bumped to next dev version (1.3.1) May 7, 2018
LICENSE.md
README.md Results of running `zf-maintainer rebase-doc-templates` May 7, 2018
composer.json Updates branch aliases May 7, 2018
composer.lock Updates branch aliases May 7, 2018
phpcs.xml Updated dependencies May 7, 2018
phpunit.xml.dist

README.md

API Blueprint Documentation Provider for Apigility

Build Status Coverage Status

Introduction

This module provides Apigility the ability to show API documentation through a Apiary documentation.

In addition to providing Apiary documentation, module also plugs in the original Apigility documentation and provides content negotiated response with raw API Blueprint.

Requirements

Please see the composer.json file.

Installation

Run the following composer command:

$ composer require zfcampus/zf-apigility-documentation-apiblueprint

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

"require": {
    "zfcampus/zf-apigility-documentation-apiblueprint": "^1.2"
}

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' => [
        /* ... */
        'ZF\Apigility\Documentation\ApiBlueprint',
    .,
    /* ... */
.;

zf-component-installer

If you use zf-component-installer, that plugin will install zf-apigility-documentation-apiblueprint as a module for you.

Usage

Apiary documentation can be found on /apigility/blueprint/:api uri and is accessible from the Apigility welcome page.

Querying API Blueprint

When raw API Blueprint is needed, request can be done via content negotiation. Target uri is /apigility/blueprint/:api and Accept header is text/vnd.apiblueprint+markdown.

To learn more about API Blueprint language, please check its specification.