zfcampus/zf-apigility-documentation-apiblueprint

Apigility API Blueprint Documentation Module

API Blueprint Documentation Provider for Apigility

Repository abandoned 2019-12-31

This repository has moved to laminas-api-tools/api-tools-documentation-apiblueprint., _(*1)

, _(*2)

Introduction

This module provides Apigility the ability to show API documentation through a Apiary documentation., _(*3)

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

Requirements

Please see the composer.json file., _(*5)

Installation

Run the following composer command:, _(*6)

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

Alternately, manually add the following to your composer.json, in the require section:, _(*7)

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

And then run composer update to ensure the module is installed., _(*8)

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

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., _(*10)

Usage

Apiary documentation can be found on /apigility/blueprint/:api uri and is accessible from the Apigility welcome page., _(*11)

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., _(*12)

To learn more about API Blueprint language, please check its specification., _(*13)