[TOC] ## 2.4 API 宿主環境提供了豐富的API，可以很方便調用微信提供的能力。幾乎所有小程序的API都掛載在wx對象底下（除了Page/App等特殊的構造器）。 小程序提供的API按照功能主要分為幾大類：網絡、媒體、文件、數據緩存、位置、設備、界面、界面節點信息還有一些特殊的開放接口，API一般調用的約定： 1. wx.on* 開頭的 API 是監聽某個事件發生的API接口，接受一個 Callback 函數作為參數。當該事件觸發時，會調用 Callback 函數。 2. 如未特殊約定，多數 API 接口為異步接口 ，都接受一個Object作為參數。 3. API的Object參數一般由success、fail、complete三個回調來接收接口調用結果，示例代碼如代碼清單3-17所示，詳細說明如表3-9所示。 4. wx.get* 開頭的API是獲取宿主環境數據的接口。 5. wx.set* 開頭的API是寫入數據到宿主環境的接口。 碼清單3-17 通過wx.request發起網絡請求 ~~~ wx.request({ url: 'test.php', data: {}, header: { 'content-type': 'application/json' }, success: function(res) { // 收到https服務成功后返回 console.log(res.data) }, fail: function() { // 發生網絡錯誤等情況觸發 }, complete: function() { // 成功或者失敗后觸發 } }) ~~~ :-: 表3-9 API接口回調說明 | 參數名字 | 類型 | 必填 | 描述 | | --- | --- | --- | --- | | success | Function | 否 | 接口調用成功的回調函數| | fail | Function | 否 | 接口調用失敗的回調函數| | complete | Function | 否 | 接口調用結束的回調函數（調用成功、失敗都會執行）| >[info] * API調用大多都是異步的， >* 有部分API會拉起微信的原生界面，此時會觸發Page的`onHide`方法，當用戶從原生界面返回到小程序時，會觸發Page的`onShow`方法。 API的數量非常多，而且隨著宿主環境的迭代更新會持續新增API，了解一般調用API的技巧，再通過[官方API文檔 ](https://mp.weixin.qq.com/debug/wxadoc/dev/api/)了解到對應的API參數細節即可。