hivecommerce/magerun2-list-api-endpoints

netz98 Magerun2 列出所有 API 端点的插件

v2.4.0 2022-04-23 08:56 UTC

This package is auto-updated.

Last update: 2024-09-06 09:59:58 UTC


README

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

Build Status Coverage Status Mastodon Follow

安装

安装 hivecommerce/magerun2-list-api-endpoints 的首选方法是使用 Composer。只需将 hivecommerce/magerun2-list-api-endpoints 添加为开发依赖项

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

本地安装

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

mkdir -p  ~/.n98-magerun2/modules

接下来,将克隆的存储库放在 ~/.n98-magerun2/modules 的子目录中

git clone git@github.com:hivecommerce/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

这两个过滤器可以组合使用,以仅显示使用 GET 方法的 customers 路由,请像这样运行 magerun2

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

贡献

请随意分支并扩展现有功能或添加新功能,并通过拉取请求发送您的更改!为了建立一致的代码质量,请为您的所有更改提供单元测试,并更新文档。

想要贡献吗?

如果您觉得您有东西要分享,那么我们非常希望您加入我们。查看贡献指南,了解如何以及我们期望您做什么。

许可证

此插件在 Apache 2.0 许可证下发布。