alexdenvir/api-tools-documentation-apiblueprint

Laminas API Tools API Blueprint Documentation Module

API Blueprint Documentation Provider for Laminas API Tools

Introduction

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

In addition to providing Apiary documentation, module also plugs in the original Laminas API Tools 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 laminas-api-tools/api-tools-documentation-apiblueprint

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

"require": {
    "laminas-api-tools/api-tools-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' => [
        /* ... */
        'Laminas\ApiTools\Documentation\ApiBlueprint',
    .,
    /* ... */
.;

laminas-component-installer

If you use laminas-component-installer, that plugin will install api-tools-documentation-apiblueprint as a module for you.

Usage

Apiary documentation can be found on /api-tools/blueprint/:api uri and is accessible from the Laminas API Tools welcome page.

Querying API Blueprint

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

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