Generate API doc

Magento 1 doesn’t have an official API Documentation, but you can generate your own API doc with a PHP open source script.

You can find this script here:

Generate your API doc input files

This script generates PHP and JSON files in your api/input directory, these files help you to generate the apiDoc.

Generate your API doc

For this step you need to install or have Docker

Your API doc is now available in api/doc/index.html


  • Link with anchor: to share a link to a specific endpoint’s documentation, select the endpoint from the sidebar and copy the URL
Edit on GitHub  or  Send us a feedback