Plugin for netz98 Magerun2 to list all API endpoints
This is a plugin for netz98 Magerun2 to list all API endpoints.
n98-magerun2 will automatically load the plugins laying under
~/.n98-magerun2/modules (create this folder if it does not exist).
To add this command, simply clone the repository.
git clone [email protected]:bitExpert/magerun2-list-api-endpoints.git ~/.n98-magerun2/modules/magerun2-list-api-endpoints
The preferred way of installing
bitexpert/magerun2-list-api-endpoints is through Composer.
bitexpert/magerun2-list-api-endpoints as a dev dependency:
composer.phar require --dev bitexpert/magerun2-list-api-endpoints
This plugin adds the
api:list:endpoints command to magerun2.
You are able to filter routes by their respective HTTP methods. To only
GET routes, run magerun2 like this:
magerun2 api:list:endpoints --method=get
To list all
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
run magerun2 like this:
magerun2 api:list:endpoints --route=customers
Both filters can be combined, to show only
customers routes with the
method, run magerun2 like this:
magerun2 api:list:endpoints --route=customers --method=get
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.
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.
This plugin is released under the Apache 2.0 license.