An unofficial, automatically generated API reference for Moodle web services.
Download the latest Moodle release and run the server. Open your browser and navigate to http://localhost:80 to create a local admin account and install all components of the Moodle platform. Activate web services in the Advanced features section (make sure to save changes).
Move the extraction script scripts/doc_json.php into <MOODLE ROOT>/server/moodle/. On your hosted Moodle website,
If you're trying to make changes to the PHP script, it's helpful to disable caching. Open server/php/php.ini and scroll to the bottom of the file to find cache related settings. Edit opcache.enable to have a value of 0 and (re-)start your Moodle server.
opcache.enable=0Debug messages are another helpful setting and can be enabled in Development > Debugging. Check the Display debug messages setting to view warnings and errors in the browser (otherwise, they'd appear in server/apache/logs/error.log).
The generated JSON files follow a custom schema inspired by OpenAPI.
Moodle's web service functions all have separate IDs passed to a single server.php endpoint path. Because there's only one endpoint, the standard OpenAPI schema can't be used for Moodle web services.