基於REST的Moodle Function API文檔

Question

我正在嘗試開發Moodle Android應用。 我正在使用MoodleREST源代碼作為參考.Moodle網站上是否有其他文檔可以記錄核心Web服務功能及其所需參數。

我在http://docs.moodle.org/dev/Web_services_Roadmap中找到了功能列表，但無法獲得有關如何使用REST從移動客戶端使用必需的參數調用這些功能的適當文檔。

我是新手，仍然學習它，所以我的問題可能有點天真，所以請忍受:)

Answer 1

這可能會有所幫助http://docs.moodle.org/dev/Creating_a_web_service_client

如果您擁有Moodle的管理員訪問權限，請轉到

yourmoodle / admin / webservice / documentation.php，或

管理>插件> Web服務> API文檔 。

有帶有文檔的API。 （不知道是否有更好的方法：/）

D.

Answer 2

AIUI，您需要管理員才能訪問最全面的Web服務API，如@Dolfa所述。 如果要針對他們的REST API進行開發，則需要這些文檔和/或源代碼。 API文檔是從源代碼生成的，因此大概可以准確地反映已安裝版本中的API。

你可以：

• 瀏覽github上的代碼
• 克隆要編程的版本，以便您可以在本地瀏覽代碼
• 安裝它並讓您自己成為admin，以便您可以瀏覽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]參數。