Moodle功能API文档通过REST介绍

Question

我正在尝试开发一款Moodle Android应用程序。我正在使用MoodleREST源代码作为参考。请问在Moodle网站上是否有其他文档记录了Moodle核心Web服务函数及其所需的参数。

我在这里找到了函数列表http://docs.moodle.org/dev/Web_services_Roadmap，但无法获得有关如何从移动客户端使用REST调用这些函数所需参数的正确文档。

我是Moodle的新手，还在学习中，因此我的问题可能有点天真，请谅解 :)

- Harshawardhan

Answer 1

这可能很有用：http://docs.moodle.org/dev/Creating_a_web_service_client 如果您有Moodle的一些管理员访问权限，可以转到yourmoodle/admin/webservice/documentation.php ，或Administration> Plugins> Web services> API Documentation。

其中包含文档的API。（不知道是否有更好的方法：/）

D.

- Dolfa

---

感谢您，我会看看的。目前我没有管理员权限。 - Harshawardhan

Answer 2

我理解你需要管理员权限才能访问最全面的Web服务API，正如@Dolfa所描述的那样。如果您正在针对其REST API进行开发，则需要这些文档和/或源代码。 API文档是从源代码生成的，因此它们可以准确地反映已安装版本中的API。

您可以：

• 在github上浏览代码
• 克隆您打算编程的版本，以便您可以本地浏览代码
• 安装并给自己授予管理员权限，以便您可以浏览API文档。

如果您不想费心设置本地Moodle实例，您可能可以找出一种运行生成文档的php的方法。

一旦您大致了解API调用的内容，通常可以通过查看命令行请求的响应来了解详细信息，例如：

curl 'https://your.domain/webservice/rest/server.phpmoodlewsrestformat=json' --data 'wsfunction=core_enrol_get_users_courses&wstoken=[your_ws_token]' --compressed | python -m "json.tool"

给出响应

{
    "debuginfo": "Missing required key in single structure: userid",
    "errorcode": "invalidparameter",
    "exception": "invalid_parameter_exception",
    "message": "Invalid parameter value detected"
}

说明该函数需要一个userid=[userid]参数。

- Paul

---

我认为你必须将开发者消息(/admin/settings.php?section=debugging)设置为高级别，才能获得“debuginfo”项。 “开发者”选项绝对有效。 - 2xj