api-docs and doctum API Generation

Table of contents

1. Overview

1. Overview Table of Contents

We use doctum to generate documentation based on phpdoc comments for describing classes and functions. Run the command to view our API documentation:

php console serve:api --port=<port_number> --host=<hostname_or_ip>

Then navigate to http://<hostname_or_ip>:<port_number>. The default is http://localhost:8001.