Skip to main content
Version: 2.x

Generate API doc

Magento 1 (or OpenMage LTS) doesn't have an official API Documentation, but you can generate your own API doc with a PHP open source script. This guide explains the process in detail.

You can find the script used below to generate the documentation at:

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