搜索zfcampus / zf-apigility-documentation-apiblueprint
Apigility API Blueprint 文档模块
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
仓库于 2019-12-31 废弃
此仓库已迁移至 laminas-api-tools/api-tools-documentation-apiblueprint。
简介
本模块为 Apigility 提供通过 Apiary 文档展示 API 文档的功能。
除了提供 Apiary 文档外，模块还集成原始 Apigility 文档，并提供与原始 API Blueprint 的内容协商响应。
要求
请参阅 composer.json 文件。
安装
运行以下 composer 命令
$ composer require zfcampus/zf-apigility-documentation-apiblueprint
或者，手动将以下内容添加到您的 composer.json 文件的 require 部分
"require": { "zfcampus/zf-apigility-documentation-apiblueprint": "^1.2" }
然后运行 composer update 以确保模块已安装。
最后，将模块名称添加到您的项目 config/application.config.php 中的 modules 键下
return [ /* ... */ 'modules' => [ /* ... */ 'ZF\Apigility\Documentation\ApiBlueprint', ., /* ... */ .;
zf-component-installer
如果您使用 zf-component-installer，该插件将自动将 zf-apigility-documentation-apiblueprint 作为模块安装。
使用方法
Apiary 文档可在 /apigility/blueprint/:api uri 上找到，并且可以从 Apigility 欢迎页面访问。
查询 API Blueprint
需要原始 API Blueprint 时，可以通过内容协商进行请求。目标 URI 是 /apigility/blueprint/:api，接受头为 text/vnd.apiblueprint+markdown。
有关 API Blueprint 语言的更多信息，请参阅其 规范。