https://github.com/weierophinney/zf-apigility-documentation-apiblueprint

API Blueprint integration for Apigility
https://github.com/weierophinney/zf-apigility-documentation-apiblueprint

Last synced: 3 days ago
JSON representation

API Blueprint integration for Apigility

• Host: GitHub
• URL: https://github.com/weierophinney/zf-apigility-documentation-apiblueprint
• Owner: weierophinney
• Created: 2015-06-23T22:04:37.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-07-14T19:14:57.000Z (over 8 years ago)
• Last Synced: 2024-12-08T00:51:33.491Z (15 days ago)
• Language: PHP
• Size: 27.3 KB
• Stars: 1
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
API Blueprint Documentation Provider for Apigility

==================================================

Introduction

------------

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

[Apiary](http://apiry.io/) documentation.

In addition to providing Apiary documentation, module also plugs in the original Apigility documentation and provides content negotiated response with raw [API Blueprint](https://apiblueprint.org).

Requirements

------------

  

Please see the [composer.json](composer.json) file.

Installation

------------

Run the following `composer` command:

```console

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

```

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

```javascript

"require": {

    "zfcampus/zf-apigility-documentation-apiblueprint": "~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:

```php

return array(

    /* ... */

    'modules' => array(

        /* ... */

        'ZF\Apigility\Documentation\ApiBlueprint',

    ),

    /* ... */

);

```

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](https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md).