IntelliJ IDEA 使用 rest client

idea 可以通过 RESTful Web 做接口调试,包括调试外部接口。具体可以参照 : https://www.jetbrains.com/help/idea/restful-webservices.html

一、准备

需要安装 RESTful Web Services 插件,通过 Ctrl + Alt + s ==> Plugins ==> 搜索 RESTful Web Services,如图:

在这里插入图片描述

二、初体验

进入 rest 控制台, idea 导航栏 ==> Tools ==> HTTP Client ==> Test RESTFUL Web Service 如图:

在这里插入图片描述

点击 Test RESTful Web Services , 效果如下 :

在这里插入图片描述

这样就完成一一个请求,如果在控制台中点击了 Convert request to the new format 就会以 .http 文件的方式保存到 Scratches and Consoles 下的 Scratches 文件夹中,如图:

在这里插入图片描述

三、创建HTTP请求文件

除了通过控制文件发送请求,也可以自己创建 .http 文件发送请求。可以通过右键 new ==> HTTP Request 指定位置创建一个 RESTful 请求文件(如下图),或者通过快捷键 Ctrl + Shift + Alt + Insert 选择 HTTP Request 创建一个临时文件文件保存到上面的 Scratches 文件夹中。

在这里插入图片描述

四、环境变量

编写HTTP请求时,可以使用环境变量来参数化其元素 。例如,可以使用{{host}}占位符代替在请求中显式提供主机名 。然后,在项目中定义一组环境变量,其中包含所需的主机定义。执行请求时,可以在定义的环境之间进行选择。

变量可以保存以下请求组件的值:

  1. 请求ip,端口和路径
  2. 查询参数或值
  3. 请求头的值
  4. 在外部文件为请求体提供任意值
定义环境变量

环境变量在环境文件中定义的,文件定义在与 .http 文件相同目录下,文件可以是 : rest-client.env.json 或者 http-client.env.json, rest-client.private.env.json 或者 http-client.private.env.json。

rest-client.env.json 或者 http-client.env.json 表示这个文件是包含普通的变量,并把里面的变量分发到项目中。

rest-client.private.env.json 或者 http-client.private.env.json 表示该文件是一个私人的文件,可能包括密码,令牌,证书和其他敏感信息。默认情况下,此文件被添加到 VCS 忽略文件列表中。在 http-client.private.env.json 文件中指定的变量的值将覆盖环境文件中的值。

具体使用

文件结构

在这里插入图片描述

report_api.http 中数据


POST {{host}}/api/employee-user/logIn
Content-Type: application/json

{
  "username": "{{username}}",
  "password": "{{password}}"
}

###

GET {{host}}/api/reportApplet/list?state=-1&type=3
Accept: */*
Cache-Control: no-cache
token: {{token}}
Content-Type: application/json

###

# 修改状态
POST {{host}}/api/operateProcessGroup/state
Accept: */*
Cache-Control: no-cache
token: {{token}}
Content-Type: application/json

{
  "id":10,
  "state": "{{enable_state}}"
}

###

POST {{host}}/api/operateProcessGroup/modify
Accept: */*
Cache-Control: no-cache
token: {{token}}
Content-Type: application/json

{
"id":10,
"name":{{unresolved-var}},
"state":0
}

http-client.env.json 中数据 :


{
  "dev": {
    "host": "http://127.0.0.1:8080",
    "token": "c10fb622c769d74200c71b46ad74afaa",
    "enable_state": "1"
  },

  "line": {
    "host": "https://www.xxx.com",
    "token": "8ad4f5f92728bf43ee807444f9d78876",
    "enable_state": "1"
  }
}

http-client.private.env.json 中数据 :


{
  "dev": {
    "username": "test",
    "password": "test"
  },

  "line": {
    "username": "admin",
    "password": "admin"
  }
}

运行时就可以选择 dev 和 line 两种方式

在这里插入图片描述

这里的 dev 和 line 对应前面 http-client.env.json 中定义的 dev 和 line。

注意: 在最后一个请求中,由于 {{unresolved-var}}未在环境文件中定义变量{{unresolved-var}},因此在种情况下,IntelliJ IDEA均会将文本作为请求的一部分发送。

五、简单语法

对于 .http 文件中的一些简单语法 :

  1. 注释 : // 或者 #
  2. 使用三个#号分割 request 请求 : ###
  3. web 的 basic 或者 digest 认证
// Basic authentication
GET http://example.com
Authorization: Basic username password

###

// Digest authentication
GET http://example.com
Authorization: Digest username password
  1. 普通请求体
POST http://example.com:8080/api/html/post
Content-Type: application/json 

{ "key" : "value", "list": [1, 2, 3] }
  1. 不添加执行日志
// @no-log
GET example.com/api

六、响应处理程序脚本

将脚本插入请求中

> 开头,然后把脚本包装在 {%%} 里面。

断言
GET https://example.com/status/200

> {%
    client.test("Request executed successfully", function() {
        client.assert(response.status === 200, "Response status is not 200");
    });
%}

脚本日志

client.log("this is log");

在这里插入图片描述

存储变量

通过 client.global.set 存储全局变量,通过 client.global.get 获取变量。可以通过 client 对象在内存中存储数据,可以保留到 idea 关闭之前。

除了 get 获取值外,还可以通过变量获取值,如图:

在这里插入图片描述

那么在一处存储了变量, 就可以在其他地方调用了,非常适合处理 token,就有点像浏览器登录了…

七、请求结果记录

请求结果一般存储在该项目的 .idea 目录下的 httpRequests 目录里面的 http-requests-log.http 文件中,如下 :

在这里插入图片描述

查看返回结果 json 通过 Ctrl + b 或者 ctrl + 鼠标左键进入返回的 json 详情,途中有误 emm…

  • 13
    点赞
  • 77
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
IntelliJ IDEA 是一款功能强大的集成开发环境(IDE),适用于 Java、Kotlin、Groovy 和其他语言。下面是一个简单的 IntelliJ IDEA 使用教程: 1. 下载和安装 IntelliJ IDEA:首先,从 IntelliJ IDEA 官方网站(https://www.jetbrains.com/idea/)下载适用于您的操作系统的安装程序。然后,按照安装向导的指示进行安装。 2. 创建新项目:启动 IntelliJ IDEA 后,选择 "Create New Project"(创建新项目)。选择您的项目类型(例如 Java、Kotlin 等),然后按照向导的指示填写项目名称和位置。 3. 导入现有项目:如果您有现有的项目,可以选择 "Import Project"(导入项目)选项,并选择项目的根目录。IntelliJ IDEA 将自动检测并配置项目。 4. 界面导览:IntelliJ IDEA 的界面包含菜单栏、工具栏、编辑区域、项目视图等。熟悉这些界面组件对于高效使用 IntelliJ IDEA 是很重要的。 5. 编辑代码:在编辑区域中打开您的源代码文件。IntelliJ IDEA 提供了强大的代码编辑功能,包括自动完成、语法高亮、代码重构等。 6. 运行和调试代码:使用菜单栏上的运行按钮或快捷键来运行您的代码。您还可以通过设置断点并使用调试功能来调试代码。 7. 版本控制:IntelliJ IDEA 集成了流行的版本控制系统,如 Git 和 SVN。您可以使用界面上的版本控制工具来管理您的代码版本。 8. 插件扩展:IntelliJ IDEA 支持大量的插件,以扩展其功能。您可以通过菜单栏中的 "Preferences"(首选项)来管理和安装插件。 以上是一个简单的 IntelliJ IDEA 使用教程。IntelliJ IDEA 提供了丰富的功能和工具,以提高开发效率和代码质量。希望对您有帮助!
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值