bitexpert/magerun2-list-api-endpoints

此包已废弃,不再维护。作者建议使用hivecommerce/magerun2-list-api-endpoints包。

netz98 Magerun2插件,用于列出所有API端点

v2.2.0 2021-03-13 12:27 UTC

README

仓库已废弃于2021-11-06

此包已废弃。请使用hivecommerce/magerun2-list-api-endpoints代替!

magerun2插件:列出所有API端点

这是一个用于列出所有API端点的netz98 Magerun2插件。

Build Status Coverage Status Infection MSI

安装

安装bitexpert/magerun2-list-api-endpoints的首选方式是通过Composer。只需将bitexpert/magerun2-list-api-endpoints添加为开发依赖项

composer.phar require --dev bitexpert/magerun2-list-api-endpoints

本地安装

如果您不想将命令添加到特定项目中,可以将插件全局安装,只需将代码放入~/.n98-magerun2/modules目录。如果您的设置中尚不存在此文件夹,可以通过运行以下命令创建文件夹

mkdir -p  ~/.n98-magerun2/modules

接下来,需要将仓库克隆到~/.n98-magerun2/modules的子目录中

git clone git@github.com:bitExpert/magerun2-list-api-endpoints.git ~/.n98-magerun2/modules/magerun2-list-api-endpoints

使用方法

此插件向magerun2添加了api:list:endpoints命令。

您可以通过各自的HTTP方法过滤路由。要仅查看GET路由,运行magerun2如下

magerun2 api:list:endpoints --method=get

要列出所有GETPOST路由,请将逗号分隔的列表作为方法参数传递

magerun2 api:list:endpoints --method=get,post

您可以通过URL过滤路由。要仅查看customers路由,运行magerun2如下

magerun2 api:list:endpoints --route=customers

这两个过滤器可以组合使用,以显示只有customers路由的GET方法,运行magerun2如下

magerun2 api:list:endpoints --route=customers --method=get

贡献

请随意fork并扩展现有功能或添加新功能,并将更改的pull request发送给我们!为了建立一致的代码质量,请为所有更改提供单元测试,并调整文档。

想要贡献?

如果您觉得有东西可以分享,我们将非常乐意欢迎您。请查看贡献指南,了解如何以及我们期望您做什么。

许可证

此插件基于Apache 2.0许可证发布。