HTTP調(diào)用是什么
在微信小程序開發(fā)過程中,經(jīng)常會使用到HTTP調(diào)用,那么HTTP調(diào)用是什么?下面就和大家詳細(xì)的介紹一下。
HTTP調(diào)用可以通過檢查用戶目錄下端口文件是否有端口文件及嘗試連接來判斷工具是否安裝/啟動。
端口文件位置:
macOS : ~/Library/Application Support/微信web開發(fā)者工具/Default/.ide
Windows : ~/AppData/Local/微信web開發(fā)者工具/User Data/Default/.ide
1.打開工具
接口定義:
URL: /open
HTTP 方法: GET
URL 參數(shù)必填說明
projectpath否打開指定路徑中的項目。如項目已打開,自動刷新項目。如項目未創(chuàng)建,自動創(chuàng)建并打開項目
示例:
# 打開工具
http://127.0.0.1:端口號/open# 打開/刷新項目
http://127.0.0.1:端口號/open?projectpath=項目全路徑
注意:
項目路徑中必須含正確格式的 project.config.json 且其中有 appid 和 projectname 字段。
項目路徑需經(jīng) URL encode
2. 登錄
接口定義:
URL:/login
HTTP 方法:GET
URL 參數(shù)必填說明
format否指定登錄二維碼返回格式,可選值有 image、base64、terminal,默認(rèn) image。圖片格式為 png
qroutput否指定文件路徑,在文件寫入二維碼數(shù)據(jù)。如指定,二維碼將被寫入指定路徑的文件內(nèi),如未指定,二維碼將作為請求相應(yīng)體返回
resultoutput否指定輸出登錄結(jié)果文件路徑
示例:
# 登錄,返回圖片格式的二維碼
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
URL 參數(shù)必填說明
projectpath是預(yù)覽指定路徑中的項目。如項目已打開,自動刷新項目。如項目未創(chuàng)建,自動創(chuàng)建并預(yù)覽項目
format否指定登錄二維碼返回格式,可選值有 image、base64、terminal,默認(rèn) image。圖片格式為 png
qroutput否指定文件路徑,在文件中寫入二維碼數(shù)據(jù)。如指定,二維碼將被寫入指定路徑的文件內(nèi),如未指定,二維碼將作為請求相應(yīng)體返回
infooutput否指定后,會將本次預(yù)覽的額外信息以 json 格式輸出至指定路徑,如代碼包大小、分包大小信息。
compilecondition否指定自定義編譯條件,值為 json 字符串,條件可指定兩個字段,pathName 表示打開的頁面,不填表示首頁,query 表示頁面參數(shù)
示例:
# 預(yù)覽路徑為 /Users/username/demo 的項目,返回圖片格式的二維碼
http://127.0.0.1:端口號/preview?projectpath=%2FUsers%2Fusername%2Fdemo# 預(yù)覽路徑為 /Users/username/demo 的項目,返回 base64 格式的二維碼
http://127.0.0.1:端口號/preview?projectpath=%2FUsers%2Fusername%2Fdemo&format=base64# 預(yù)覽路徑為 /Users/username/demo 的項目,返回 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 的項目,返回圖片格式的二維碼,并將預(yù)覽信息輸出至 /Users/username/info.json
http://127.0.0.1:端口號/preview?projectpath=%2FUsers%2Fusername%2Fdemo&infooutput=%2Users%2username%2info.json# 預(yù)覽路徑為 /Users/username/demo 的項目,指定自定義編譯條件,啟動頁為 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
URL 參數(shù)必填說明
projectpath是上傳指定路徑中的項目
version是版本號
desc否本次上傳的版本備注
infooutput否指定后,會將本次上傳的額外信息以 json 格式輸出至指定路徑,如代碼包大小、分包大小信息。
示例:
# 上傳路徑為 /Users/username/demo 的項目,指定版本號為 v1.0.0
http://127.0.0.1:端口號/upload?projectpath=%2FUsers%2Fusername%2Fdemo&version=v1.0.0# 上傳路徑為 /Users/username/demo 的項目,指定版本號為 v1.0.0,并帶上備注
http://127.0.0.1:端口號/upload?projectpath=%2FUsers%2Fusername%2Fdemo&version=v1.0.0&desc=test# 上傳路徑為 /Users/username/demo 的項目,指定版本號為 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
URL 參數(shù)必填說明
projectpath是上傳指定路徑中的項目
compiletype否編譯類型,miniprogram (默認(rèn)) 或 plugin
示例:
# 構(gòu)建路徑為 /Users/username/demo 的項目
http://127.0.0.1:端口號/buildnpm?projectpath=%2FUsers%2Fusername%2Fdemo&compiletype=miniprogram
6. 自動化測試
接口定義:
URL:/test
HTTP 方法:GET
URL 參數(shù)必填說明
projectpath是測試指定路徑中的項目
示例:
# 提交路徑為 /Users/username/demo 的項目進(jìn)行測試
http://127.0.0.1:端口號/test?projectpath=%2FUsers%2Fusername%2Fdemo
請求響應(yīng)
正常情況下 HTTP 相應(yīng)狀態(tài)碼為 200,錯誤時 400,返回如下格式的 JSON 字符串:
{
“code”: 40000,
“error”: “原因”
}
7. 自動預(yù)覽
接口定義:
URL:/autopreview
HTTP 方法:GET
URL 參數(shù)必填說明
projectpath是指定路徑中的項目。如項目已打開,自動刷新項目。如項目未創(chuàng)建,自動創(chuàng)建并自動預(yù)覽項目
infooutput否指定后,會將本次自動預(yù)覽的額外信息以 json 格式輸出至指定路徑,如代碼包大小、分包大小信息。
示例:
# 自動預(yù)覽路徑為 /Users/username/demo 的項目,返回圖片格式的二維碼,并將預(yù)覽信息輸出至 /Users/username/info.json
http://127.0.0.1:端口號/autopreview?projectpath=%2FUsers%2Fusername%2Fdemo&infooutput=%2Users%2username%2info.json
以上就是HTTP調(diào)用具體介紹,希望以上的內(nèi)容,對大家有所幫助!
版權(quán)聲明:
本站所有文章和圖片均來自用戶分享和網(wǎng)絡(luò)收集,文章和圖片版權(quán)歸原作者及原出處所有,僅供學(xué)習(xí)與參考,請勿用于商業(yè)用途,如果損害了您的權(quán)利,請聯(lián)系網(wǎng)站客服處理。