Can I use this for AJAX requests within Moodle?

Yes, by setting the 'ajax' property to true in the db/services.php registration, the API becomes available for internal Moodle AJAX calls.

What is the mandatory three-method pattern in Moodle APIs?

Moodle requires execute_parameters() for input structure, execute() for business logic, and execute_returns() for the output structure definition.

Does it support database transactions?

Yes, the skill includes implementation patterns for using Moodle's delegated transactions to ensure data integrity during multi-step database operations.

How does this skill handle security?

It enforces Moodle's security standards by implementing validate_context() and require_capability() checks to ensure only authorized users can access the data.

Where should the API files be located in a Moodle plugin?

Following Moodle's autoloading standards, API class files should be placed in the /classes/external/ directory of your plugin.

Moodle External API Developer

Name: Moodle External API Developer
Author: claudiodearaujo

byclaudiodearaujo

API 开发

Develops secure, standards-compliant external web service APIs for Moodle LMS plugins and integrations.

关于

This skill provides a comprehensive framework for building custom Moodle web services, ensuring full adherence to Moodle's strict three-method architectural pattern. It guides developers through parameter validation, security capability checking, and structured data returns, making it an essential tool for creating robust REST or AJAX endpoints for course management, mobile app backends, and external system integrations within the Moodle ecosystem.

主要功能

Implements the mandatory Moodle three-method API pattern (parameters, execution, returns)
Automates web service registration and configuration in db/services.php
Enforces security through context validation and capability checks
Provides advanced patterns for database transactions and course module management
Handles robust parameter validation using Moodle's PARAM_* constants
0 GitHub stars

使用场景

Integrating external HR or SIS systems with Moodle course enrollment
Building custom backends for Moodle Mobile app extensions
Creating AJAX-driven interfaces for custom Moodle activity plugins

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add claudiodearaujo/izacenter moodle-external-api-development

For use in Claude.ai and ChatGPT

Download Skill

GitHub

关于