微信小游戲開發(fā)文檔小游戲開發(fā)工具HTTP 調(diào)用

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

HTTP

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

端口號(hào)文件位置：

macOS : ~/Library/Application Support/微信web開發(fā)者工具/Default/.ide

Windows : ~/AppData/Local/微信web開發(fā)者工具/User Data/Default/.ide

1. 打開工具或指定項(xiàng)目

接口定義：

URL： /open

HTTP 方法: GET

示例：

# 打開工具
http://127.0.0.1:端口號(hào)/open
# 打開/刷新項(xiàng)目
http://127.0.0.1:端口號(hào)/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:端口號(hào)/login
# 登錄，取 base64 格式二維碼
http://127.0.0.1:端口號(hào)/login?format=base64
# 登錄，取 base64 格式二維碼，并寫入 /Users/username/logincode.txt
http://127.0.0.1:端口號(hào)/login?format=base64&qroutput=%2FUsers%2Fusername%2Flogincode.txt

3. 預(yù)覽

接口定義：

URL：/preview

HTTP 方法：GET

示例：

# 預(yù)覽路徑為 /Users/username/demo 的項(xiàng)目，返回圖片格式的二維碼
http://127.0.0.1:端口號(hào)/preview?projectpath=%2FUsers%2Fusername%2Fdemo
# 預(yù)覽路徑為 /Users/username/demo 的項(xiàng)目，返回 base64 格式的二維碼
http://127.0.0.1:端口號(hào)/preview?projectpath=%2FUsers%2Fusername%2Fdemo&format=base64
# 預(yù)覽路徑為 /Users/username/demo 的項(xiàng)目，返回 base64 格式的二維碼，并寫入 /Users/username/logincode.txt
http://127.0.0.1:端口號(hào)/preview?projectpath=%2FUsers%2Fusername%2Fdemo&format=base64&qroutput=%2FUsers%2Fusername%2Flogincode.txt

4. 上傳

接口定義：

URL：/upload

HTTP 方法：GET

示例：

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

5. 自動(dòng)化測(cè)試

接口定義：

URL：/test

HTTP 方法：GET

示例：

# 提交路徑為 /Users/username/demo 的項(xiàng)目進(jìn)行測(cè)試
http://127.0.0.1:端口號(hào)/test?projectpath=%2FUsers%2Fusername%2Fdemo

請(qǐng)求響應(yīng)

正常情況下 HTTP 相應(yīng)狀態(tài)碼為 200，錯(cuò)誤時(shí) 400，返回如下格式的 JSON 字符串：

{
  "code": 40000,
  "error": "原因"
}