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

2020-07-17 10:14 更新

HTTP調(diào)用

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

HTTP調(diào)用說(shuō)明

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

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

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

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

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

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

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

tips:

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

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

可用接口

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

接口定義:

URL: /open

HTTP 方法: GET

URL參數(shù) 必填 說(shuō)明 projectpath
打開(kāi)指定路徑中的項(xiàng)目。若項(xiàng)目路徑正確填寫則打開(kāi)項(xiàng)目,未填寫項(xiàng)目路徑則打開(kāi)開(kāi)發(fā)者工具。

示例:

  1. ## 打開(kāi)工具
  2. http://127.0.0.1:端口號(hào)/open
  3. ## 打開(kāi)/刷新項(xiàng)目
  4. 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

URL參數(shù) 必填 說(shuō)明
format 指定登錄二維碼返回格式,可選值有 image、base64、terminal,默認(rèn) image。圖片格式為 png
qroutput 指定文件路徑,在文件寫入二維碼數(shù)據(jù)。如指定,二維碼將被寫入指定路徑的文件內(nèi),如未指定,二維碼將作為請(qǐng)求相應(yīng)體返回
resultoutput 指定輸出登錄結(jié)果文件路徑

示例:

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

3 預(yù)覽

接口定義:

URL:/preview

HTTP 方法:GET

URL參數(shù) 必填 說(shuō)明
projectpath 預(yù)覽指定路徑中的項(xiàng)目。如項(xiàng)目已打開(kāi),自動(dòng)刷新項(xiàng)目。如項(xiàng)目未創(chuàng)建,自動(dòng)創(chuàng)建并預(yù)覽項(xiàng)目
format 指定登錄二維碼返回格式,可選值有 image、base64、terminal,默認(rèn) image。圖片格式為 png
qroutput 指定文件路徑,在文件中寫入二維碼數(shù)據(jù)。如指定,二維碼將被寫入指定路徑的文件內(nèi),如未指定,二維碼將作為請(qǐng)求相應(yīng)體返回
infooutput 指定后,會(huì)將本次預(yù)覽的額外信息以 json 格式輸出至指定路徑,如代碼包大小、分包大小信息。
compilecondition 指定自定義編譯條件,值為 json 字符串,條件可指定兩個(gè)字段,pathName 表示打開(kāi)的頁(yè)面,不填表示首頁(yè),query 表示頁(yè)面參數(shù)

示例:

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

4 上傳代碼

接口定義:

URL:/upload

HTTP 方法:GET

URL參數(shù) 必填 說(shuō)明
projectpath 上傳指定路徑中的項(xiàng)目
version 版本號(hào)
desc 本次上傳的版本備注
infooutput 指定后,會(huì)將本次上傳的額外信息以 json 格式輸出至指定路徑,如代碼包大小、分包大小信息。

示例:

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

5 構(gòu)建 npm

接口定義:

URL:/buildnpm

HTTP 方法:GET

URL參數(shù) 必填 說(shuō)明
projectpath 指定路徑中的項(xiàng)目
compiletype 編譯類型,miniprogram (默認(rèn)) 或 plugin

示例:

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

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

接口定義:

URL:/close

HTTP 方法:GET

URL參數(shù) 必填 說(shuō)明
projectpath 指定路徑中的項(xiàng)目

示例:

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

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

接口定義:

URL:/quit

HTTP 方法:GET

  1. 退出開(kāi)發(fā)者工具
  2. http://127.0.0.1:端口號(hào)/quit
以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)