[Postman]接口测试Post、Get请求方法

ゝ一纸荒年。 2023-06-24 09:25 35阅读 0赞

前言：  
现在做项目基本都是前后端分离了，这样更方便了开发，我们只需要负责自己的部分，调试接口就可以了，少去很多麻烦，下面就根据一个项目介绍一下Postman的使用，希望对大家有用。

#### Postman介绍 ####

用户在开发或者调试网络程序或者是网页B/S模式的程序的时候是需要一些方法来跟踪网页请求的，用户可以使用一些网络的监视工具。比如著名的FireBug等网页调试工具。而Postman这款网络调试工具不仅可以调试简单的CSS、HTML、脚本等简单的网页基本信息，它还可以发送几乎所有类型的HTTP请求！Postman在发送网络HTPP请求方面可以说是Chrome插件类产品中的代表产品之一。

#### Postman环境与安装 ####

postman适用于不同的操作系统，Postman Mac、Windows X32、Windows X64、Linux系统，还支持postman 浏览器扩展程序、postman chrome应用程序等。  
具体参考文档：进入如下链接  
[官方英文文档][Link 1]  
Windows下在地址如下：  
[Windows下载地址][Windows]  
安装就不介绍了，按照步骤来就行了，没什么特别的。

#### HTTP相关基础知识 ####

1.  HTTP的请求方法
    
     *  GET ：请求指定的页面信息，并返回实体主体。（通常用来接收数据）
     *  POST：向指定资源提交数据进行处理请求，数据被包含在请求体中。POST请求可能会导致新的资源的建立、以有资源的修改。（通常用来发送数据）
     *  HEAD：类似于GET请求，支部返回的响应中没有具体内容，用于获取报头
     *  PUT：从客户端向服务器传送的数据取代指定的文档的内容
     *  DELETE：请求服务器删除指定的页面
     *  CONNECT：能够将连接改为管道方式的代理服务器
     *  OPTIONS：允许客户端查看服务器的性能
     *  TRACE：显示服务器收到的请求，主要用于测试或诊断
2.  接口调用传参方式：

*  key-value参数：把参数拼接在URL的后面由？相连，多个参数之间用&相连
 *  Json串传参：需求在请求的body中，入Json格式参数

#### Restful API ####

REST，表示状态转移。也就是说，就是用URI表示资源，用HTTP方法表征对这些资源的操作。  
RESTful API 就是REST风格的API。现在终端平台多样，移动、平板、PC等许多媒介向服务端发送请求后，如果不适用RESTful API，需要为每个平台的数据请求定义相应的返回格式，以适应前端显示。但是RESTful API 要求前端以一种预定义的语法格式发送请求，那么服务端就只需要定义一个统一的响应接口，不必像之前那样解析各色各式的请求。  
Restful是典型的基于HTTP的协议。他有哪些设计规则和规范呢？  
1.资源：首先要明确资源就是网络上的一个实体，可以是文本、图片、音频、视频。资源总是以一定的格式来表现自己。文本用txt、html；图片用JPG、JPEG等等。而JSON是RESTful API中最常用的资源表现格式。  
2.统一接口：对于业务数据的CRUD，RESTful 用HTTP方法与之对应。

<table> 
 <thead> 
  <tr> 
   <th>CRUD</th> 
   <th>HTTP Methods</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Create</td> 
   <td>POST</td> 
  </tr> 
  <tr> 
   <td>Read</td> 
   <td>GET</td> 
  </tr> 
  <tr> 
   <td>Update</td> 
   <td>PUT</td> 
  </tr> 
  <tr> 
   <td>Delete</td> 
   <td>DELETE</td> 
  </tr> 
 </tbody> 
</table>

3.URI:统一资源标识符，他可以唯一标识一个资源。注意到，URL（统一资源定位符）是一种URI，因为他可以唯一标志资源。但URL!=URI。应该说URL是URI的子集。因为URL使用路径来唯一标识资源，这只是唯一标识资源的一种方式。还可以用一个唯一编号来标识资源，如example.html.fuce2da23。只不过这种方式并不被广泛使用。总之，要在概念上对URL和URI有所区分。  
4.无状态：所谓无状态是指所有资源都可以用URI定位，而且这个定位与其他资源无关，不会因为其他资源的变动而变化。这里引入一个幂等性的概念：无论一个操作被执行一次还是多次，执行后的效果都相同。比如对某资源发送GET请求，如果访问一次和访问十次获得的数据一样，那么就说这个请求具有幂等性。  
5.URL中只能有名词，不能出现动词。这是因为在REST要求对资源的操作由HTTP 方法给出，而方法是由HTTP 请求报文头部给出的，自然不需要在URL中暴露操作方式。

#### 举例说明 ####

##### 1.GET方法 #####

@ApiOperation("获取指定id的品牌详情")
        @RequestMapping(value = "/{id}", method = RequestMethod.GET)
        @ResponseBody
     // @PreAuthorize("hasAuthority('pms:brand:read')")
        public CommonResult<PmsBrand> brand(@PathVariable("id") Long id) { 
            return CommonResult.success(brandService.getBrand(id));
        }

postman调接口如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5Mzk3MTY1_size_16_color_FFFFFF_t_70]  
URL上写好id号，点击发送就可以了。

##### 2. POST方法 #####

@ApiOperation("添加品牌")
        @RequestMapping(value = "/create", method = RequestMethod.POST)
        @ResponseBody
       // @PreAuthorize("hasAuthority('pms:brand:create')")
        public CommonResult createBrand(@RequestBody PmsBrand pmsBrand) { 
            CommonResult commonResult;
            int count = brandService.createBrand(pmsBrand);
            if (count == 1) { 
                commonResult = CommonResult.success(pmsBrand);
                LOGGER.debug("createBrand success:{}", pmsBrand);
            } else { 
                commonResult = CommonResult.failed("操作失败");
                LOGGER.debug("createBrand failed:{}", pmsBrand);
            }
            return commonResult;
        }

POSTMAN测试接口如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5Mzk3MTY1_size_16_color_FFFFFF_t_70 1]

这里要说一下要注意Header下的类型，因为我用的是application/json，所以要选这个类型，否则调接口无法成功。

今天就暂时分享这两个方法，其他方法类同，以后有时间在分享把。

[Link 1]: https://learning.getpostman.com/docs/v6/
[Windows]: https://app.getpostman.com/app/download/win32?_ga=2.21151352.2119858274.1527039878-1088353859.1527039878
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5Mzk3MTY1_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191222151405401.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5Mzk3MTY1,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5Mzk3MTY1_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/2019122215152794.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5Mzk3MTY1,size_16,color_FFFFFF,t_70