Desenvolvimento de APIs Externas para Moodle

Esta habilidade guia você na criação de APIs de serviços web externas personalizadas para o Moodle LMS, seguindo o framework de API externa e os padrões de codificação do Moodle.

Guia Detalhado

Leia o guia detalhado antes de executar esta habilidade. Ele contém o procedimento completo e o material de referência. Trate seus requisitos de segurança, pré-requisitos e validação como obrigatórios. Para um trabalho focado, carregue as seções relevantes; para um trabalho de ponta a ponta, leia o guia completamente.

Quando Usar Esta Habilidade

• Criação de serviços web personalizados para plugins do Moodle
• Implementação de endpoints REST/AJAX para gerenciamento de cursos
• Construção de APIs para operações de questionário, rastreamento de usuários ou relatórios
• Exposição de funcionalidades do Moodle para aplicações externas
• Desenvolvimento de backends de aplicativos móveis usando o Moodle

Exemplos de Implementação Real

API Simples de Leitura (Obter Tentativas de Questionário)

<?php
namespace local_userlog\external;

defined('MOODLE_INTERNAL') || die();
require_once("$CFG->libdir/externallib.php");

use external_api;
use external_function_parameters;
use external_single_structure;
use external_value;

class get_quiz_attempts extends external_api {
    public static function execute_parameters() {
        return new external_function_parameters([
            'userid' => new external_value(PARAM_INT, 'User ID'),
            'courseid' => new external_value(PARAM_INT, 'Course ID')
        ]);
    }

    public static function execute($userid, $courseid) {
        global $DB;

        self::validate_parameters(self::execute_parameters(), [
            'userid' => $userid,
            'courseid' => $courseid
        ]);

        $sql = "SELECT COUNT(*) AS quiz_attempts
                FROM {quiz_attempts} qa
                JOIN {quiz} q ON qa.quiz = q.id
                WHERE qa.userid = :userid AND q.course = :courseid";

        $attempts = $DB->get_field_sql($sql, [
            'userid' => $userid,
            'courseid' => $courseid
        ]);

        return ['quiz_attempts' => (int)$attempts];
    }

    public static function execute_returns() {
        return new external_single_structure([
            'quiz_attempts' => new external_value(PARAM_INT, 'Total number of quiz attempts')
        ]);
    }
}

API Complexa de Escrita (Criar Questionário a partir de Categorias)

Veja o anexo create_quiz_from_categories.php para um exemplo abrangente incluindo:

• Múltiplas inserções no banco de dados
• Criação de módulo de curso
• Configuração de instância de questionário
• Seleção aleatória de perguntas com tags
• Restrições de acesso baseadas em grupos
• Extensa geração de logs de erros
• Gerenciamento de transações

Limitações

• Use esta habilidade apenas quando a tarefa corresponder claramente ao escopo descrito acima.
• Não trate a saída como um substituto para validação específica do ambiente, testes ou revisão de especialistas.
• Pare e peça esclarecimentos se os inputs necessários, permissões, limites de segurança ou critérios de sucesso estiverem ausentes.