moodle-external-api-development

What problem does it solve?

This Skill provides a structured approach for creating Moodle external web service APIs, enabling secure, standards-compliant integration with external systems while reducing boilerplate.

Core Features & Use Cases

• Three-method pattern: execute_parameters, execute, and execute_returns to define, implement, and return API data.
• Safety and access control: parameter validation, context checks, and capability enforcement to ensure proper permissions.
• Service registration & consumption: guidance for registering functions, exposing REST/AJAX endpoints, and mobile service usage.
• Best practices: error handling, logging, transactions, and coding standards for Moodle plugins.

Quick Start

Create a new external API class following the three-method pattern and register it in services.php to expose the API.