Download the PHP package zfcampus/zf-apigility-documentation-apiblueprint without Composer
On this page you can find all versions of the php package zfcampus/zf-apigility-documentation-apiblueprint. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zfcampus/zf-apigility-documentation-apiblueprint
More information about zfcampus/zf-apigility-documentation-apiblueprint
Files in zfcampus/zf-apigility-documentation-apiblueprint
Package zf-apigility-documentation-apiblueprint
Short Description Apigility API Blueprint Documentation Module
License BSD-3-Clause
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package zf-apigility-documentation-apiblueprint
API Blueprint Documentation Provider for Apigility
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:
Alternately, manually add the following to your composer.json, in the require section:
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:
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.
All versions of zf-apigility-documentation-apiblueprint with dependencies
zendframework/zend-eventmanager Version ^2.6.3 || ^3.0.1
zendframework/zend-mvc Version ^2.7.15 || ^3.0.4
zendframework/zend-servicemanager Version ^2.7.6 || ^3.1
zendframework/zend-view Version ^2.8.1
zfcampus/zf-api-problem Version ^1.2.1
zfcampus/zf-apigility-documentation Version ^1.2
zfcampus/zf-content-negotiation Version ^1.2.1