zfcampus / zf-apigility-documentation-apiblueprint
Apigility API Blueprint Documentation Module
Installs: 50 919
Dependents: 0
Suggesters: 0
Security: 0
Stars: 13
Watchers: 7
Forks: 6
Open Issues: 0
Requires
- php: ^5.6 || ^7.0
- zendframework/zend-eventmanager: ^2.6.3 || ^3.0.1
- zendframework/zend-mvc: ^2.7.15 || ^3.0.4
- zendframework/zend-servicemanager: ^2.7.6 || ^3.1
- zendframework/zend-view: ^2.8.1
- zfcampus/zf-api-problem: ^1.2.1
- zfcampus/zf-apigility-documentation: ^1.2
- zfcampus/zf-content-negotiation: ^1.2.1
Requires (Dev)
- phpunit/phpunit: ^5.7.27 || ^6.5.8 || ^7.1.5
- zendframework/zend-coding-standard: ~1.0.0
This package is auto-updated.
Last update: 2020-01-07 22:50:35 UTC
README
Repository abandoned 2019-12-31
This repository has moved to laminas-api-tools/api-tools-documentation-apiblueprint.
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.