接口是软件开发中常用的概念,是软件生产过程中比较核心的任务。对于接口开发者,调试接口是一件较为繁琐的事情,很多时候需要线上线下来回切换。在这里,我就跟大家介绍一个只需要在本地就可以调试接口的方法,即使用postman进行接口测试。
Postman是一款强大的API开发和测试工具,为开发者提供了直观且易用的界面,支持发送HTTP请求、测试和调试API。它不仅提供了简便的方式来构建请求,还允许用户自定义请求头、参数和身份验证。Postman的突出特点包括环境变量和脚本功能,支持全面的接口测试和自动化。无论是初学者还是有经验的开发者,Postman都是一个不可或缺的工具,大大简化了API开发和测试的流程,提高了工作效率。
一、下载Postman
我们先去访问Postman的官网,下载 Postman 。
选择适合电脑系统的 Postman 软件版本,因为我是 Windows 64位 系统,所以我选择 Windows 64位 版本的 Postman 。选择完版本后,点击下载。
二、安装Postman
下载完成后,双击exe程序,Postman 会自动安装,安装完注册登录。
三、创建新的Request
进入 Postman 主界面,点击 Start something new 里的 Create a request,创建一个 request 类型的接口测试项目。
四、填写参数测试
以模拟 GET请求 为例,选择请求方式为 GET ,然后输入接口的访问地址(接口访问需保证调试的接口项目正在本地运行),Params 里写入要传递的参数,点击 Send 按钮发送。
Postman 提供两种参数的写入方式,一种是 <Key,Value>键值对 ,另一种是 Bulk包体传输,我们可以点击界面右方的 Bulk Edit 切换这两种写入方式。
再以 POST请求 为例,我们传递一段 JSON 字符串,选择 POST 为请求方式,编辑 Header(请求头)中的 Content-Type 为 application/json,在 Body 里填入Json字符串,选择 raw(纯文本)格式发送,点击Send。
五、查看返回结果
若接口正常则会返回相应的值,我的返回值是:
{"status":1,"msg":"update_success"}
这个返回值表示我的接口运行正常。
六、实例演示
下面用Java实现了一个简单的接口,通过post请求可以向接口发送一个字符串,接口返回Hello+字符串的组合。
1、创建接口
ExampleController.java
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ExampleController {
@PostMapping("/example")
public ExampleResponse example(@RequestBody ExampleRequest request) {
// 在这里处理请求,并返回相应的响应对象
ExampleResponse response = new ExampleResponse();
response.setMessage("Hello, " + request.getName() + "!");
return response;
}
}
ExampleRequest.java
public class ExampleRequest {
private String name;
// 省略构造函数和getter/setter方法
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
ExampleResponse.java
public class ExampleResponse {
private String message;
// 省略构造函数和getter/setter方法
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
}
2、postman创建请求
我们勾选啊Post请求,输入请求url:http://localhost:8080/example;
参数在Body里输入,选择raw格式的json:
{
"name": "John"
}
3、发送请求查看结果
点击Send发送,这个JSON将被作为请求体发送到 /example 接口。
可以看到返回值为:
{
"message": "Hello, John!"
}
这是从 /example 端点接收到的响应体。