Magento 1 REST API documentation generator

Magento PHP script for generate your Magento API REST documentation.

Installation & Usage

1. Generate input files

• Download the file generateApiDoc.php and past it on your Magento's shell directory
• Create api/input and api/doc directory on your Magento's
• Run this script with php generateApiDoc.php (Magento need to be up for working)

after running, this script create 2 new files on your api/input directory. This file help you to generate the apiDoc

2. Generate doc with apiDoc

• With Docker :
  • In your Magento's root directory, run docker run --rm -v $(pwd)/api:/home/node/apidoc dmitrymomot/apidoc -o doc -i input ($(pwd) is for Linux, for other system see https://stackoverflow.com/questions/41485217/mount-current-directory-as-a-volume-in-docker-on-windows-10#answer-41489151
• With Npm :
  • You need to install https://github.com/apidoc/apidoc
  • In your Magento's root directory, run apidoc -i api/input/ -o api/doc/

You can now access to your Magento 1 REST API documentation on {MAGENTO_BASE_URL}/api/doc/index.html

Contributing

This is a collaborative project. Pull requests are welcome

Example

You can see the result when you generate documentation on Magento LTS: https://ph2m.github.io/Magento1-Generate-Api-Doc/index.html