How does this skill handle security?

It enforces Moodle's internal security checks, including validate_context() and require_capability() to ensure only authorized users access the API data.

What is the three-method pattern in Moodle APIs?

Every Moodle external API must implement execute_parameters() for input definition, execute() for business logic, and execute_returns() for the response structure.

Where should the API files be located?

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

Does it support database transactions?

Yes, the skill provides patterns for starting, committing, and rolling back delegated transactions to ensure data integrity during complex operations.

Can I use this for AJAX calls within Moodle?

Yes, the skill includes configurations for the db/services.php file to enable AJAX support, allowing your plugin's frontend to communicate with the backend.

Moodle API Development

Name: Moodle API Development
Author: claudiodearaujo

byclaudiodearaujo

API 开发

Develops robust, secure custom external web service APIs for Moodle LMS following official architectural patterns and coding standards.

关于

This skill provides comprehensive guidance for building custom Moodle web services, ensuring compliance with Moodle's strict external API framework. It automates the creation of the required three-method class structure (parameters, logic, and returns), handles complex database operations, and manages service registration in the plugin database. By following these patterns, developers can safely expose Moodle functionality to external applications, mobile apps, or AJAX frontends while maintaining enterprise-grade security, capability checks, and rigorous data validation.

主要功能

Implements secure parameter validation using Moodle PARAM constants
0 GitHub stars
Includes advanced patterns for course module management and transactions
Provides templates for db/services.php registration
Automates capability and context checks for LMS security
Generates the mandatory Moodle external API three-method pattern

使用场景

Creating AJAX endpoints for interactive course elements in a custom plugin
Developing external reporting tools that securely fetch data from Moodle
Building a custom REST API for a Moodle mobile application

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

关于