README

This is a plugin for netz98 Magerun2 to list all API endpoints.

Installation

The preferred way of installing hivecommerce/magerun2-list-api-endpoints is through Composer. Simply add hivecommerce/magerun2-list-api-endpoints as a dev dependency:

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

Local installation

If you do not want to add the command to one specific project only, you can install the plugin globally by placing the code in the ~/.n98-magerun2/modules directory. If the folder does not already exist in your setup, create the folder by running the following command:

mkdir -p  ~/.n98-magerun2/modules

The next thing to do is to clone the repository in a subdirectory of ~/.n98-magerun2/modules:

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

Usage

This plugin adds the api:list:endpoints command to magerun2.

You are able to filter routes by their respective HTTP methods. To only see GET routes, run magerun2 like this:

magerun2 api:list:endpoints --method=get

To list all GET and POST routes, pass a comma-separated list as method argument:

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

You are able to filter routes by their url. To only see customers routes, run magerun2 like this:

magerun2 api:list:endpoints --route=customers

Both filters can be combined, to show only customers routes with the GET method, run magerun2 like this:

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

Contribute

Please feel free to fork and extend existing or add new features and send a pull request with your changes! To establish a consistent code quality, please provide unit tests for all your changes and adapt the documentation.

Want To Contribute?

If you feel that you have something to share, then we’d love to have you. Check out the contributing guide to find out how, as well as what we expect from you.

License

This plugin is released under the Apache 2.0 license.