介绍
explorer-cli-http
是一个可以用命令行访问 HTTP 接口的 npm 包。可以用来测试 API 接口,调试 HTTP 请求以及一些数据处理任务。
安装
你可以通过 npm 安装它,使用以下命令:
npm install -g explorer-cli-http
安装成功后,你可以在命令行使用 explorer
命令。
命令
GET 请求
使用 get
命令来发送 GET 请求:
explorer get http://localhost:3000/api/user/123
POST 请求
使用 post
命令来发送 POST 请求:
explorer post http://localhost:3000/api/user -d '{"name": "张三", "age": 18}'
其中 -d
参数表示要发送的 JSON 数据。
PUT 请求
使用 put
命令来发送 PUT 请求:
explorer put http://localhost:3000/api/user/123 -d '{"name": "张三", "age": 18}'
DELETE 请求
使用 delete
命令来发送 DELETE 请求:
explorer delete http://localhost:3000/api/user/123
变量替换
你可以使用变量来替换 URL 或请求体中的某些值。变量以 $
开头,可以为一个环境变量或一个自定义变量。
以下是一个例子,使用环境变量替换 URL 中的值:
export SERVER_HOST=localhost:3000 explorer get http://$SERVER_HOST/api/user/$USER_ID
其中 $USER_ID
是一个自定义变量。
你也可以在请求体中使用变量:
export USER_NAME=张三 explorer post http://localhost:3000/api/user -d '{"name": "$USER_NAME", "age": 18}'
超时设置
你可以使用 -t
参数来设置超时时间,单位为毫秒:
explorer get http://localhost:3000/api/user/123 -t 5000
表示请求超时时间为 5 秒。
输出格式
你可以使用 -H
参数来设置输出格式,目前支持 pretty
, json
, yaml
, csv
, table
, md
:
explorer get http://localhost:3000/api/user/123 -H table
输出结果将会以表格形式显示。
验证
你可以使用 -a
参数来设置 HTTP 请求所需的验证信息:
explorer get http://localhost:3000/api/user/123 -a "Bearer $ACCESS_TOKEN"
其中 $ACCESS_TOKEN
是一个环境变量。
上传文件
你可以使用 -f
参数来上传一个文件:
explorer post http://localhost:3000/api/upload -F "file=@/path/to/file"
其中 @
后面的是文件路径。
总结
explorer-cli-http
是一个功能强大的命令行 HTTP 请求工具,能够极大地提升开发过程中的效率。在实际开发中,你可以通过使用它来快速测试 API 接口、调试 HTTP 请求、处理数据等任务。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055cdf81e8991b448da7ec