开发者工具提供了命令行与 HTTP 服务两种接口供外部调用,开发者可以通过命令行或 HTTP 请求指示工具进行登录、预览、上传等操作。
HTTP
http 服务在工具启动后自动开启,HTTP 服务端口号在用户目录下记录,可通过检查用户目录、检查用户目录下是否有端口文件及尝试连接来判断工具是否安装/启动。
端口号文件位置:
macOS : ~/Library/Application Support/微信web开发者工具/Default/.ide
Windows : ~/AppData/Local/微信web开发者工具/User Data/Default/.ide
1. 打开工具或指定项目
接口定义:
URL: /open
HTTP 方法: GET
URL 参数 |
必填 |
说明 |
projectpath |
否 |
打开指定路径中的项目。如项目已打开,自动刷新项目。如项目未创建,自动创建并打开项目 |
示例:
http://127.0.0.1:端口号/open
http://127.0.0.1:端口号/open?projectpath=项目全路径
注意:
- 项目路径中必须含正确格式的 project.config.json 且其中有 appid 和 projectname 字段。
- 项目路径需经 URL encode
2. 登录
接口定义:
URL:/login
HTTP 方法:GET
URL 参数 |
必填 |
说明 |
format |
否 |
指定登录二维码返回格式,可选值有 image、base64、terminal,默认 image。图片格式为 png |
qroutput |
否 |
指定文件路径,在文件写入二维码数据。如指定,二维码将被写入指定路径的文件内,如未指定,二维码将作为请求相应体返回 |
示例:
http://127.0.0.1:端口号/login
http://127.0.0.1:端口号/login?format=base64
http://127.0.0.1:端口号/login?format=base64&qroutput=%2FUsers%2Fusername%2Flogincode.txt
3. 预览
接口定义:
URL:/preview
HTTP 方法:GET
URL 参数 |
必填 |
说明 |
projectpath |
是 |
预览指定路径中的项目。如项目已打开,自动刷新项目。如项目未创建,自动创建并预览项目 |
format |
否 |
指定登录二维码返回格式,可选值有 image、base64、terminal,默认 image。图片格式为 png |
qroutput |
否 |
指定文件路径,在文件中写入二维码数据。如指定,二维码将被写入指定路径的文件内,如未指定,二维码将作为请求相应体返回 |
示例:
http://127.0.0.1:端口号/preview?projectpath=%2FUsers%2Fusername%2Fdemo
http://127.0.0.1:端口号/preview?projectpath=%2FUsers%2Fusername%2Fdemo&format=base64
http://127.0.0.1:端口号/preview?projectpath=%2FUsers%2Fusername%2Fdemo&format=base64&qroutput=%2FUsers%2Fusername%2Flogincode.txt
4. 上传
接口定义:
URL:/upload
HTTP 方法:GET
URL 参数 |
必填 |
说明 |
projectpath |
是 |
上传指定路径中的项目 |
version |
是 |
版本号 |
desc |
否 |
本次上传的版本备注 |
示例:
http://127.0.0.1:端口号/upload?projectpath=%2FUsers%2Fusername%2Fdemo&version=v1.0.0
http://127.0.0.1:端口号/upload?projectpath=%2FUsers%2Fusername%2Fdemo&version=v1.0.0&desc=test
5. 自动化测试
接口定义:
URL:/test
HTTP 方法:GET
URL 参数 |
必填 |
说明 |
projectpath |
是 |
测试指定路径中的项目 |
示例:
http://127.0.0.1:端口号/test?projectpath=%2FUsers%2Fusername%2Fdemo
请求响应
正常情况下 HTTP 相应状态码为 200,错误时 400,返回如下格式的 JSON 字符串: {
"code": 40000,
"error": "原因"
}
|
请发表评论