Cursor rule

1---
2description:
3globs:
4alwaysApply: false
5---
6---
7name: Moodle Web Services and API Development
8---
9 
10# Moodle Web Services and API Development
11 
12## Purpose
13Ensure secure, maintainable, and standards-compliant web services and APIs in Moodle.
14 
15## Instructions
16- Use Moodle's web service API for exposing functionality
17- Define external functions in `db/services.php` and `externallib.php`
18- Use parameter validation and capability checks in all API endpoints
19- Return data in standard formats (JSON, XML)
20- Document all API endpoints and parameters
21- Use tokens or OAuth2 for authentication
22- Log API usage and errors
23- Version APIs for backward compatibility
24 
25## Examples
26```php
27// File: ./db/services.php
28$services = [
29    'myplugin_service' => [
30        'functions' => ['myplugin_get_data'],
31        'restrictedusers' => 0,
32        'enabled' => 1,
33    ],
34];
35 
36// File: ./externallib.php
37function myplugin_get_data_parameters() {
38    return new external_function_parameters([
39        'id' => new external_value(PARAM_INT, 'User ID'),
40    ]);
41}
42```
43 
44## Exceptions
45- Internal-only APIs may skip authentication with justification
46