IDEA httpClient插件

2020-02-24 本文已影响0人 lclandld

最近疫情在家，偶然间看到了这个idea 自带的httpClient,发现对我很有用，主要是能保留参数，于是自己研究了一番。毕竟我只研究了对我有用的，还有很多没涉及到的，有需要的朋友自行到官网查看官方文档

一、是否已安装好插件

在Tools 下是否能找到Http Client，能找到，表示Idea已经默认安装，直接使用即可

Idea已经默认安装

如果找不到，则到File->Settings->Plugins->Marketplace下搜索Http Client进行安装、重启即可

image.png

二、具体使用

2.1、打开方式1（文件存放在Scratches 文件夹）

关于方框里面的这种方式呢，提示已经被废弃,不使用

image.png

点开右边的蓝色字体 Convert request to the new format，进入到如下界面

image.png
默认会创建一个名为 rest-api.http 的文件，该文件被存储在 Scratches 文件夹下，就是最左边的方框里面，最右边的小方框，点开会看到默认的一些模板，打开即可！

默认模板分类

post-request.http模板

2.2、打开方式2（文件可以提交到git，推荐这种）

在项目中新建一个存放http文件的文件夹，右键文件夹->File->New->HTTP Request （文件存放在我们指定的目录下，通过 Git 提交到仓库，大家共享文件，共同维护接口请求数据，自然就不会出现调试别人接口还要导入他人数据的情况）

image.png

2.3、以项目实际为例

调用登录接口，获取Token，
通过登录得到的Token来进行其他的接口请求（一个get，一个post）

2.3.1 登录接口，获取token

### Admin登录接口
POST http://localhost:8081/admin/login
Content-Type: application/json

{
 "mobile": "13888888888",
 "password": "123456"
}

image.png

2.3.2根据Token，调用一个get请求的接口

###获取租户详情
GET http://localhost:8081/admin/tenant/findById?id = 1231816358256214017
Authorization:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJsb2dpbkZyb21BcHBJZCI6IjExNDA4ODE5NzIxOTM5MTA3ODUiLCJ1c2VyTm8iOiIxMTQxMTY5MzI2NTYxMzI1MDU3IiwidGVuYW50SWQiOiIxMTQwOTE1OTI4Njc1MTE1MDEwIiwiZXhwIjoxNTgxOTA0MjkyfQ.EvJfL_f754jh7zcNhkWXjunxxgse73iE1TnKLILSbXs
Accept: application/json

image.png

2.3.3根据Token，调用一个post请求的接口

### 添加数据接口
POST http://localhost:8081/admin/tenant/add
Authorization:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJsb2dpbkZyb21BcHBJZCI6IjExNDA4ODE5NzIxOTM5MTA3ODUiLCJ1c2VyTm8iOiIxMTQxMTY5MzI2NTYxMzI1MDU3IiwidGVuYW50SWQiOiIxMTQwOTE1OTI4Njc1MTE1MDEwIiwiZXhwIjoxNTgxOTA0MjkyfQ.EvJfL_f754jh7zcNhkWXjunxxgse73iE1TnKLILSbXs
Content-Type: application/json

{
  "userName": "httpClient",
  "password": "123456",
  "userMobile": "18780108964",
  "name": "httpClient新增租户",
  "tenantMobile": "18780108694",
  "logoAddress": "测试地址",
  "typeId": 1231767150362939393,
  "address": "demoData",
  "wxMpOpen": 1,
  "wxMpAppId": "demoData",
  "wxMpSecret": "demoData",
  "wxMpTmpId": "demoData"
}

image.png

2.4、上面的接口重构

我们可以看到，2.3里面已经基本可以发送请求了，但是一个项目中很多接口，如何快速生成参数？如何快速切换端口？如何让登录之后的每个请求自动携带Token？，所有这里进行一个重构，主要从以下两个方面进行重构

2.4.1环境变量

环境变量的概念
根据官方文档知道，在项目内部是可以创建以下两个文件：
①rest-client.env.json（或http-client.env.json）是一个包含常规变量的普通文件。（该文件里可以定义用在整个项目上的所有常规变量）
②在rest-client.private.env.json（或http-client.private.env.json）是一个私有的文件，可能包括密码、令牌、证书、其他敏感信息。默认情况下，此文件被添加到VCS的ignore文件列表中。在http-client.private.env.json文件中指定的变量的值将覆盖环境文件中的值。因为它的优先级最高

官方文档两个文件的定义
环境变量的定义
rest-client.env.json

{
  "dev": {
    "host": "localhost",
    "port": 8081,
    "mobile": "",
    "password": "",
   "tenant_id":1231816358256214017
  },
  "prd": {
    "host": "test.com",
    "port": 8082,
    "mobile": "",
    "password": ""
  }
}

rest-client.private.env.json

{
  "dev": {
    "mobile": "132222222221",
    "password": "123456"
  },
  "prd": {
    "mobile": "135555443322",
    "password": "123456"
  }
}

环境变量的具体使用
我们在环境变量中定义了一个dev和一个prd，在运行接口的时候，直接选择运行哪个环境即可

image.png

选dev开发环境，运行结果如下

host port变量

url中参数id的值放在环境变量文件中的

参数变量

2.4.2 response handler 脚本

脚本的方式
①直接引用（就地插入脚本，在脚本前面加上>并将其包含在{% %}）

GET host/api/test

> {%
// Response Handler Script
...
%}

②外部文件方式（外部文件插入脚本，在脚本前添加>外部文件路径）

    GET host/api/test

    > scripts/my-script.js

HTTP Response Handler 库公开的两个对象介绍（具体的使用方法请看官方链接）
① client对象存储会话元数据，可以在脚本内部对其进行修改。该client直到关闭IntelliJ IDEA的状态保存。保存client.global的每个变量 variable_name 都可以通过后续的HTTP请求访问{{variable_name}}。
② response 包含有关已接收响应的信息：其内容类型，状态，响应正文等。
脚本的具体使用

将获取到的token设置到全部变量中

image.png

代码如下：

### Tenant登录接口
POST http://{{host}}:{{port}}/tenant/login
Content-Type: application/json

{
  "mobile": "13666666666",
  "password": "123456"
}
> {% client.global.set("auth_token",response.body.result.token)
%}

使用刚才的全局变量值：注意系统给的模板是这样子的Authorization: Bearer {{auth_token}}，但是我没成功，最后我去掉了Bearer和那个空格才OK

image.png

三、Live Template

可以看到在这里会提示使用模板变量进行快速生成

image.png

这是系统默认的一些模板，如果不合适自己，可以按照我的另外一篇文章，进行自定义

image.png

四、遇到的问题

识别不到环境变量
是因为配置环境变量的文件rest-client.private.env.json位置没放正确，不能放到Scratches中，我理解的是放到和pom.xml同一层目录即可

image.png
Authorization老是提示token无效
原因一：用了系统自带的模板，有Bearer
原因二：在去掉了Bearer之后，:和{{auth_token}}之间留了一个空格
（正确应该去掉空格Authorization:{{auth_token}}）

image.png
POST请求提示500错误，但是又没进入到接口当中
是因为我把Content-Type: application/json中的Content-Type不知道怎么写成了Accept

POST http://{{host}}:{{port}}/admin/tenant/enableLiveBroadcast
Authorization:{{auth_token}}
Content-Type: application/json

{
  "id": 1228230930170372097,
  "enableLiveBroadcast": 1
}

IDEA httpClient插件

一、是否已安装好插件

二、具体使用

2.1、打开方式1（文件存放在Scratches 文件夹）

2.2、打开方式2（文件可以提交到git，推荐这种）

2.3、以项目实际为例

2.3.1 登录接口，获取token

2.3.2根据Token，调用一个get请求的接口

2.3.3根据Token，调用一个post请求的接口

2.4、上面的接口重构

2.4.1环境变量

2.4.2 response handler 脚本

三、Live Template

四、遇到的问题

猜你喜欢

热点阅读