How does this skill handle security in Moodle?

It enforces Moodle's security framework by requiring context validation (validate_context), capability checks (require_capability), and strict parameter cleaning using standard PARAM_* types.

Where are the new API functions registered?

The skill guides you through registering your functions in the /db/services.php file of your plugin to make them accessible to the Moodle web service core.

Can I use this for mobile app development?

Yes, it is specifically designed to create the backend web services required for Moodle Mobile and other external application integrations.

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

Moodle requires external APIs to implement execute_parameters() for input validation, execute() for core business logic, and execute_returns() for defining the specific output structure.

Does it support complex database operations?

Yes, it includes patterns for delegated transactions and parameterized SQL queries to ensure data integrity and prevent SQL injection during multi-table operations.

Moodle External API Developer

Name: Moodle External API Developer
Author: claudiodearaujo

byclaudiodearaujo

API Development

Streamlines the creation of custom REST and AJAX web services for Moodle LMS following official architectural patterns and security standards.

About

This skill provides comprehensive guidance for building robust external APIs within the Moodle LMS ecosystem. It automates the implementation of the mandatory three-method pattern—parameters, logic, and returns—while ensuring compliance with Moodle's strict coding standards, security contexts, and capability checks. Whether you are developing mobile app backends, third-party integrations, or custom AJAX endpoints for plugins, this tool handles complex database operations, transaction management, and service registration to ensure seamless and secure data exchange.

Key Features

Integrated database transaction management and parameterized query generation
Automated 3-method pattern implementation for execute_parameters, execute, and execute_returns
Context-aware security and capability verification for API endpoints
Standardized service registration and configuration for db/services.php
Strict Moodle parameter validation and type-safe data handling using standard PARAM constants
0 GitHub stars

Use Cases

Building high-performance REST APIs for custom Moodle plugins and integrations
Developing secure backends for Moodle mobile application data synchronization
Implementing AJAX endpoints for interactive dashboard reporting and course management tools

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add claudiodearaujo/sistema-de-narra-o-de-livro-front moodle-external-api-development

For use in Claude.ai and ChatGPT

Download Skill

GitHub