laminas-api-tools / api-tools-documentation-apiblueprint
Laminas API Tools API Blueprint 文档模块
Requires
- php: ~8.0.0 || ~8.1.0 || ~8.2.0
- laminas-api-tools/api-tools-api-problem: ^1.6
- laminas-api-tools/api-tools-content-negotiation: ^1.8
- laminas-api-tools/api-tools-documentation: ^1.6
- laminas/laminas-eventmanager: ^3.2
- laminas/laminas-mvc: ^2.7.15 || ^3.0.4
- laminas/laminas-servicemanager: ^3.11
- laminas/laminas-view: ^2.8.1
Requires (Dev)
- laminas/laminas-coding-standard: ~2.3.0
- phpunit/phpunit: ^9.5.5
- psalm/plugin-phpunit: ^0.16.0
- vimeo/psalm: ^4.7
Conflicts
README
🇷🇺 俄罗斯公民
我们,Laminas的参与者,来自不同的国家。我们中许多人有在俄罗斯和乌克兰的朋友、亲戚和同事。我们中的一些人在俄罗斯出生。我们中的一些人目前住在俄罗斯。我们中的一些人的祖父母在第二次世界大战中与法西斯作战。在这里,没有人支持法西斯主义。
我们中的一位成员有一个乌克兰亲戚,她和儿子一起逃离了家园。火车因前方的轰炸而延误。我们有朋友在防空洞里躲避。我们在空袭后焦急地等待他们的消息,空袭不分青红皂白地袭击医院、学校、幼儿园和住宅。我们不是从任何媒体上得知这些,我们亲眼目睹了这一切。
您足够信任我们使用我们的程序,我们请求您再次信任我们。我们需要帮助。走出家门,抗议这场毫无意义的战争。停止杀戮。说“停止战争!”
🇺🇸 致俄罗斯公民
我们Laminas的成员来自世界各地。我们中许多人有在俄罗斯和乌克兰的朋友、家人和同事。我们中的一些人在俄罗斯出生。我们中的一些人目前住在俄罗斯。我们中的一些人的祖父母在第二次世界大战中与纳粹作战。在这里,没有人支持法西斯主义。
我们的团队成员中有一位乌克兰亲戚,她和儿子一起逃离了家园。火车因前方的轰炸而延误。我们有朋友在防空洞里躲避。我们在空袭后焦急地等待他们的消息,空袭不分青红皂白地袭击医院、学校、幼儿园和住宅。我们不是从任何媒体上得知这些,这是我们亲身体验的。
您足够信任我们使用我们的软件。我们请求您在这件事上信任我们。我们需要您的帮助。走出家门,抗议这场不必要的战争。停止杀戮。说“停止战争!”
介绍
本模块为Laminas API Tools提供通过Apiary文档显示API文档的功能。
除了提供Apiary文档外,该模块还集成原始的Laminas API Tools文档,并提供了与原始API Blueprint的内容协商响应。
需求
请参阅composer.json文件。
安装
运行以下composer
命令
$ composer require laminas-api-tools/api-tools-documentation-apiblueprint
或者,手动将以下内容添加到您的composer.json
文件中的require
部分
"require": { "laminas-api-tools/api-tools-documentation-apiblueprint": "^1.2" }
然后运行composer update
以确保模块已安装。
最后,将模块名称添加到您的项目config/application.config.php
文件下的modules
键中
return [ /* ... */ 'modules' => [ /* ... */ 'Laminas\ApiTools\Documentation\ApiBlueprint', ., /* ... */ .;
laminas-component-installer
如果您使用laminas-component-installer,该插件将为您安装api-tools-documentation-apiblueprint作为模块。
使用方法
Apiary文档可以在/api-tools/blueprint/:api
URI上找到,并可以从Laminas API Tools欢迎页面访问。
查询API Blueprint
需要原始API Blueprint时,可以通过内容协商进行请求。目标URI是/api-tools/blueprint/:api
,Accept头是text/vnd.apiblueprint+markdown
。
想了解更多关于API Blueprint语言的信息,请查看其规范。