QQ小程序 HTTP調(diào)用

HTTP調(diào)用

開發(fā)者工具提供了命令行工具與 HTTP 服務(wù)兩種方式供外部調(diào)用，開發(fā)者可以通過命令行或 HTTP 請求指示工具進(jìn)行登錄、預(yù)覽、上傳等操作。

HTTP調(diào)用說明

HTTP 服務(wù)在開發(fā)者工具開啟安全服務(wù)端口后可以使用，HTTP 服務(wù)端口號在用戶目錄下記錄，可通過檢查用戶目錄、檢查用戶目錄下是否有端口文件及嘗試連接來判斷工具是否安裝/啟動(dòng)。

端口號文件位置：

• macOS： ~/Library/Application Support/QQ小程序開發(fā)者工具/Default/.ide

• Windows： ~/AppData/Local/QQ小程序開發(fā)者工具/User Data/Default/.ide

HTTP調(diào)用使用方式：

• 開啟安全服務(wù)端口： 打開開發(fā)者工具 -> 打開 工具欄-設(shè)置 選項(xiàng) -> 選擇“安全”設(shè)置 -\> 開啟服務(wù)端口。服務(wù)端口開啟后，下次打開開發(fā)者工具會自動(dòng)打開安全服務(wù)端口。

• 使用HTTP調(diào)用： 打開瀏覽器，輸入需要調(diào)用的接口的http路徑，如打開開發(fā)者工具：http：//127.0.01:端口號/open

tips:

• HTTP服務(wù)端口號可在端口號文件位置查看，也可在開發(fā)者工具的工具欄-設(shè)置-安全設(shè)置中查看。

• 以下HTTP服務(wù)均需在安全服務(wù)端口打開的情況下使用

可用接口

1 打開開發(fā)者工具或指定項(xiàng)目

接口定義：

URL： /open

HTTP 方法： GET

示例：

## 打開工具
http://127.0.0.1:端口號/open
## 打開/刷新項(xiàng)目
http://127.0.0.1:端口號/open?projectpath=項(xiàng)目全路徑

注意：

• 項(xiàng)目路徑中必須含正確格式的 project.config.json 且其中有 appid 和 projectname 字段。

• 項(xiàng)目路徑需經(jīng) URL encode

2 登錄

接口定義：

URL：/login

HTTP 方法：GET

示例：

## 登錄，返回圖片格式的二維碼
http://127.0.0.1:端口號/login
## 登錄，取 base64 格式二維碼
http://127.0.0.1:端口號/login?format=base64
## 登錄，取 base64 格式二維碼，并寫入 /Users/username/logincode.txt
http://127.0.0.1:端口號/login?format=base64&qroutput=%2FUsers%2Fusername%2Flogincode.txt
## 登錄，并寫入登錄結(jié)果到 /Users/username/loginresult.json
http://127.0.0.1:端口號/login?resultoutput=%2FUsers%2Fusername%2Floginresult.json

3 預(yù)覽

接口定義：

URL：/preview

HTTP 方法：GET

示例：

## 預(yù)覽路徑為 /Users/username/demo 的項(xiàng)目，返回圖片格式的二維碼
http://127.0.0.1:端口號/preview?projectpath=%2FUsers%2Fusername%2Fdemo
## 預(yù)覽路徑為 /Users/username/demo 的項(xiàng)目，返回 base64 格式的二維碼
http://127.0.0.1:端口號/preview?projectpath=%2FUsers%2Fusername%2Fdemo&format=base64
## 預(yù)覽路徑為 /Users/username/demo 的項(xiàng)目，返回 base64 格式的二維碼，并寫入 /Users/username/logincode.txt
http://127.0.0.1:端口號/preview?projectpath=%2FUsers%2Fusername%2Fdemo&format=base64&qroutput=%2FUsers%2Fusername%2Flogincode.txt
## 預(yù)覽路徑為 /Users/username/demo 的項(xiàng)目，返回圖片格式的二維碼，并將預(yù)覽信息輸出至 /Users/username/info.json
http://127.0.0.1:端口號/preview?projectpath=%2FUsers%2Fusername%2Fdemo&infooutput=%2Users%2username%2info.json
## 預(yù)覽路徑為 /Users/username/demo 的項(xiàng)目，指定自定義編譯條件，啟動(dòng)頁為 pages/index/index，參數(shù)為 x=1&y=2
http://127.0.0.1:端口號/preview?projectpath=%2FUsers%2Fusername%2Fdemo&compilecondition={"pathName":"pages/index/index","query":"a3=1"}

4 上傳代碼

接口定義：

URL：/upload

HTTP 方法：GET

示例：

## 上傳路徑為 /Users/username/demo 的項(xiàng)目，指定版本號為 v1.0.0
http://127.0.0.1:端口號/upload?projectpath=%2FUsers%2Fusername%2Fdemo&version=v1.0.0
## 上傳路徑為 /Users/username/demo 的項(xiàng)目，指定版本號為 v1.0.0，并帶上備注
http://127.0.0.1:端口號/upload?projectpath=%2FUsers%2Fusername%2Fdemo&version=v1.0.0&desc=test
## 上傳路徑為 /Users/username/demo 的項(xiàng)目，指定版本號為 v1.0.0，并將上傳信息輸出至 /Users/username/info.json
http://127.0.0.1:端口號/upload?projectpath=%2FUsers%2Fusername%2Fdemo&version=v1.0.0&infooutput=%2Users%2username%2info.json

5 構(gòu)建 npm

接口定義：

URL：/buildnpm

HTTP 方法：GET

示例：

## 構(gòu)建路徑為 /Users/username/demo 的項(xiàng)目
http://127.0.0.1:端口號/buildnpm?projectpath=%2FUsers%2Fusername%2Fdemo&compiletype=miniprogram

6 關(guān)閉當(dāng)前項(xiàng)目窗口

接口定義：

URL：/close

HTTP 方法：GET

示例：

關(guān)閉指定項(xiàng)目
http://127.0.0.1:端口號/close?projectpath=%2FUsers%2Fusername%2Fdemo

7 關(guān)閉開發(fā)者工具

接口定義：

URL：/quit

HTTP 方法：GET

退出開發(fā)者工具
http://127.0.0.1:端口號/quit