关于快速测试API接口的一个新技能

前言

我们大家在日常开发过程中,或多或少都涉及到 API 接口的测试。例如,有的小伙伴使用 Chrome 的 Postman 插件,或者使用火狐的 restclient 等工具。事实上,这些工具是测试 API 接口非常有效的方式之一,笔者之前也一直使用 Postman 完成 API 接口的测试工作。今天,笔者推荐另外一个非常好用的小工具,能够帮助读者快速测试 API 接口。这个工具就是 IDEA 的 Editor REST Client。

IDEA 的 Editor REST Client 在 IntelliJ IDEA 2017.3 版本就开始支持,在 2018.1 版本添加了很多的特性。事实上,它是 IntelliJ IDEA 的 HTTP Client 插件。

开始工作

首先,我们可以在任意目录下创建一个 xxx.http 文件,如图所示。

这里,我们需要使用 ### 进行 HTTP 请求分割,并在后面添加注释,案例如下所示。

### 用户登录
POST http://localhost:8088/oauth/token?grant_type=password&username=lgz&password=123456
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: Basic client secret
Cache-Control : no-cache

因此,我们获得的响应内容。

多环境配置

在开发过程中,我们通常会存在多套环境,例如开发环境、测试环境、预发环境、生产环境 等。因此,如果 Editor REST Client 能够像 Postman 一样做到多环境配置就太棒了。事实上,Editor REST Client 已经支持了这个特性,我们只需要创建 rest-client.env.json 文件,并且配置多环境信息即可。

{
 "development" : {
 "url" : "http://localhost:8088",
 "token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
 },
 "test" : {
 "url" : "http://localhost:8089",
 "token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
 },
 "preproduction" : {
 "url" : "http://activity.720ui.com",
 "token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
 },
 "product" : {
 "url" : "http://activity.720ui.com",
 "token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
 }
}

此时,改造之前的 URL,将 http://localhost:8088 改造成 url 代替。

POST /oauth/token?grant_type=password&username=lgz&password=123456

这里,我们获得的整体效果。

案例详解

现在,我们来写一个完整的案例。

### 创建用户信息
POST /v1/m/users
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization:
{
 "username": "xiaoyue",
 "realname": "小岳",
 "password": "111111",
 "email": "lianggzone@163.com",
 "tel": "18305930000",
 "weixin": "LiangGzone",
 "sex": 1
}

### 修改用户信息
PUT /v1/m/users/723181
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization:
CachePATCH-Control : no-cache
{
 "username": "xiaoyue"
}

### 查询用户信息
GET /v1/c/users/lgz/username
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: 

### 查询用户信息列表
GET /v1/c/users?keyword=梁
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: 

参考资料

https://marketplace.visualstudio.com/items?itemName=humao.rest-clientt

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对我们的支持。

(0)

相关推荐

  • java实现小i机器人api接口调用示例

    复制代码 代码如下: package com.weixin.util; import java.io.IOException;import java.util.Random;import org.apache.commons.codec.binary.Hex;import org.apache.commons.codec.digest.DigestUtils;import org.apache.commons.httpclient.HttpClient;import org.apache.com

  • 浅谈java调用Restful API接口的方式

    摘要:最近有一个需求,为客户提供一些RestfulAPI接口,QA使用postman进行测试,但是postman的测试接口与java调用的相似但并不相同,于是想自己写一个程序去测试RestfulAPI接口,由于使用的是HTTPS,所以还要考虑到对于HTTPS的处理.由于我也是首次使用Java调用restful接口,所以还要研究一番,自然也是查阅了一些资料. 分析:这个问题与模块之间的调用不同,比如我有两个模块frontend和backend,frontend提供前台展示,backend提供数据支

  • 用Java实现全国天气预报的api接口调用示例

    step1:选择本文所示例的接口"全国天气预报接口" 聚合数据url:http://www.juhe.cn/docs/api/id/39/aid/87 step2:每个接口都需要传入一个参数key,相当于用户的令牌,所以第一步你需要申请一个key. step3:学过java的同学们都知道,当我们对一个类或者方法不明白其意图和思想时,我们可以去查看文档,这里也不例外,而且对于英文不是特别好的同学来说很幸运的是,聚合网站上的文档都是中文版本的,比起阅读java源码里的英文文档应该轻松很多.

  • java微信开发API第三步 微信获取以及保存接口调用凭证

    微信如何获取以及保存接口调用凭证,下面就为大家进行介绍 一.说明 *详细说明请参考前两篇文章. *本文分为三部分:     接口调用凭证access_token的作用以及解释     如何获取接口调用凭证access_token     如何实现微信文档所说的"中控服务器"的实现以保存access_token * 本文结束会给出包括本文前三篇文章的所有演示源码  为什么要获取和保存接口调用凭证access_token  •开始开发-获取接口调用凭据 ◦文档地址:http://mp.we

  • SpringMVC Restful api接口实现的代码

    [前言] 面向资源的 Restful 风格的 api 接口本着简洁,资源,便于扩展,便于理解等等各项优势,在如今的系统服务中越来越受欢迎. .net平台有WebAPi项目是专门用来实现Restful api的,其良好的系统封装,简洁优雅的代码实现,深受.net平台开发人员所青睐,在后台服务api接口中,已经逐步取代了辉煌一时MVC Controller,更准确地说,合适的项目使用更加合适的工具,开发效率将会更加高效. python平台有tornado框架,也是原生支持了Restful api,在

  • 微信API接口大全

    微信入口绑定,微信事件处理,微信API全部操作包含在这些文件中. 微信支付.微信红包.微信卡券.微信小店. 1. [代码]index.php <?php include_once 'lib.inc.php'; $wcObj = new WeChat("YOUKUIYUAN"); $wcObj->wcValid(); 2. [代码]微信入口类 <?php /** * Description of wechat * * @author Administrator */ c

  • 关于快速测试API接口的一个新技能

    前言 我们大家在日常开发过程中,或多或少都涉及到 API 接口的测试.例如,有的小伙伴使用 Chrome 的 Postman 插件,或者使用火狐的 restclient 等工具.事实上,这些工具是测试 API 接口非常有效的方式之一,笔者之前也一直使用 Postman 完成 API 接口的测试工作.今天,笔者推荐另外一个非常好用的小工具,能够帮助读者快速测试 API 接口.这个工具就是 IDEA 的 Editor REST Client. IDEA 的 Editor REST Client 在

  • Nest.js快速启动API项目过程详解

    目录 快速启动 使用nest自带的命令行工具 直接使用starter项目 用npm安装所需的包 创建controller 创建service 结构和命名 HTTP请求 处理Axios对象 配置 全局添加headers API文档 快速启动 最近上了一个新项目,这个客户管理一个庞大的任务和团队集群,而不同流程所适用的系统也不太一样,比如salesforce,hubspots之类的.这次的新项目需要在另外两个平台之间做一些事情.目前只需要先封装其中之一的API,因此我们选定使用NodeJS的框架Ne

  • 如何设计一个安全的API接口详解

    目录 前言 一 安全性问题 1.1 调用接口的先决条件-token 1.2 使用POST作为接口请求方式 1.3 客户端IP白名单 1.4 单个接口针对ip限流 1.5 记录接口请求日志 1.6 敏感数据脱敏 二 幂等性问题 三 数据规范问题 3.1 版本控制 3.2 响应状态码规范 3.3 统一响应数据格式 总结 前言 在日常开发中,总会接触到各种接口.前后端数据传输接口,第三方业务平台接口.一个平台的前后端数据传输接口一般都会在内网环境下通信,而且会使用安全框架,所以安全性可以得到很好的保护

  • IdentityServer4实现.Net Core API接口权限认证(快速入门)

    什么是IdentityServer4 官方解释:IdentityServer4是基于ASP.NET Core实现的认证和授权框架,是对OpenID Connect和OAuth 2.0协议的实现. 通俗来讲,就是服务端对需要认证授权的资源(客户端请求资源)在外层使用IdentityServer4框架进行封装加壳,用户只能通过获取IdentityServer4颁发的Token令牌才能进行资源访问. 下面开始进入正题,如何快速搭建实现API接口鉴权. 准备:1.下载准备NetCore sdk环境 2.

  • 脚本测试postman快速导出python接口测试过程示例

    Postman的脚本可以导出多种语言的脚本,方便二次维护开发. Python的requests库,支持python2和python3,用于发送http/https请求 使用unittest进行接口自动化测试 01.环境准备 1.安装python(使用python2或3都可以) 2.安装requests:pip install requests 电脑中同时存在python2和python3时会出现安装错误如下: Python3下安装: Pip的版本太低,无法安装其他模块 升级pip 成功安装req

  • Spring Boot整合Swagger测试api构建全纪录

    什么是Swagger? Swagger是什么:THE WORLD'S MOST POPULAR API TOOLING 根据官网的介绍: Swagger Inspector:测试API和生成OpenAPI的开发工具.Swagger Inspector的建立是为了解决开发者的三个主要目标. 执行简单的API测试 生成OpenAPI文档 探索新的API功能 我的理解Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大

  • 用Node编写RESTful API接口的示例代码

    前言 本文介绍了如何用Node开发web程序,并通过一个todo list练习来介绍如何创建符合RESTful风格的API接口. 创建HTTP服务器 用Node创建HTTP服务器是非常方便的. 创建HTTP服务器要调用http.createServer()函数,它只有一个参数,是个回调函数,服务器每次收到HTTP请求后都会调用这个回调函数.这个回调会收到两个参数,请求和响应对象,通常简写为req和res: var http = require('http') var server = http.

  • Django使用AJAX调用自己写的API接口的方法

    在这个例子中,我们将使用Django编写饿了么高校外卖商家查询API接口,并且使用AJAX技术来实现API接口的使用,包括使用ajax get方法加载更多数据,使用ajax方法来更新.修改.新增.删除数据.利用API可以做到前后端分离,为开发web应用提供了便利. 安装rest framework 首先使用Pycharm新建一个Django项目,并且使用virtualenv或者pipenv虚拟环境 创建成功会自动安装Django2.1和所需依赖,restframework框架需要自己手动安装 /

  • Django+RestFramework API接口及接口文档并返回json数据操作

    系统:ubuntu18.04 x64 GitHub:https://github.com/xingjidemimi/DjangoAPI.git 安装 pip install django==2.1.5 pip install djangorestframework # rest api pip install coreapi pygments markdown # 自动化接口文档 API示例 创建django项目 django-admin startproject DjangoAPI 创建应用

随机推荐