Generate API documentation

Learn how to generate API documentation for your Magento 1 store using Front-Commerce's API documentation tool.

You can find the script used below to generate the documentation at: https://github.com/PH2M/Magento1-Generate-Api-Doc

Generate your API doc input files

• Download the following PHP script https://github.com/PH2M/Magento1-Generate-Api-Doc/blob/develop/generateApiDoc.php
• Paste it in your Magento's shell directory
• Create api/input and api/doc directories in your Magento's root directory
• Ensure your Magento is available and working fine (database configured, etc.)
• Run the following script php shell/generateApiDoc.php

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 https://github.com/apidoc/apidoc or have Docker

• With Docker:
  • In your Magento's root directory, run docker run --rm -v $(pwd)/api:/home/node/apidoc apidoc/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/

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

Tips

• Link with anchor: to share a link to a specific endpoint's documentation, select the endpoint from the sidebar and copy the URL