关于软件测试:基于-Spring-Boot-的-RESTful-API-设计与实现

RESTful 是一种标准，合乎 RESTful 的 Api 就是 RESTful Api。简略的说就是可联网设备利用 HTTP 协定通过 GET、POST、DELETE、PUT、PATCH 来操作具备 URI 标识的服务器资源，返回对立格局的资源信息，包含 JSON、XML、CSV、ProtoBuf、其余格局。
RESTful 的核心思想是，客户端收回的数据操作指令都是"动词 + 宾语"的构造。比方，GET /case 这个命令，GET 是动词，/case 是宾语。

RESTful API简介

RESTful 架构遵循对立接口准则，不管什么样的资源，都是通过应用雷同的接口进行资源的拜访。接口应该应用规范的 HTTP 办法如 GET ，PUT 和 POST ，并遵循这些办法的语义。
设计规范

罕用的动词有以下 5 个

详情见 https://www.w3.org/Protocols/...

Spring Boot 实现 RESTful API

咱们能够通过 Spring Boot 注解来实现 RESTful API 。

当初须要编写的是对一个用户的增删改查操作，如下表是一个非 RESTful 和规范 RESTful 的比照表。

上面咱们着重介绍下以下两对注解。

Controller 个别利用在有返回界面的利用场景下。例如，治理后盾应用了模板技术如 thymeleaf 开发，须要从后盾间接返回 Model 对象到前台，那么这时候就须要应用 Controller 来注解。

RestController 个别利用在只有接口的利用场景下. 例如开发前后端拆散的我的项目时，通过 Ajax 申请服务端接口，那么接口就应用 RestController 对立注解。

须要留神的是 RestController 是 Controller 的子集。RestController 是 Spring4 后新加的注解，从 RestController 注解源码能够看出 RestController 是 Controller 和 ResponseBody 两个注解的结合体，即Controller=RestController+ResponseBody。

RestController 注解源码

@Target({ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Controller@ResponseBodypublic @interface RestController {    @AliasFor(        annotation = Controller.class    )    String value() default "";}

RequestMapping 和GetMapping/PostMapping/PutMapping/DeleteMapping 作用一样，其实能够互相替换，后者是前者的简化版本。

GetMapping 其实就等于将 RequestMapping 注解的 method 属性设置为 GET，PostMapping 其实就等于将 RequestMapping 注解的 method 属性设置为 POST，PutMapping、DeleteMapping 其实就等于将 RequestMapping 注解的 method 属性别离设置为 PUT、DELETE。

也就是说GetMapping、PostMapping、PutMapping、DeleteMapping 是 RequestMapping 的子集。

咱们来看看 RequestMapping 的源码：

@Target({ElementType.TYPE, ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Mappingpublic @interface RequestMapping {    String name() default "";    //申请URI    @AliasFor("path")    String[] value() default {};    @AliasFor("value")    String[] path() default {};    //申请类型，如 GET、POST、PUT、DELETE 等    RequestMethod[] method() default {};    //申请参数中必须蕴含某些参数值，才让该办法解决。    String[] params() default {};    //申请参数中必须蕴含某些指定的header值，能力让该办法解决申请。    String[] headers() default {};    //申请的内容类型（Content-Type），例如application/json, text/html;    String[] consumes() default {};    //响应的内容类型，仅当 request 申请头中的( Accept )类型中蕴含该指定类型才返回；    String[] produces() default {};}

示例阐明：

新增 2 个文件：dto/UserDto.java 和 controller/HogwartsTestUserController.java ，其中 UserController 类中包含了对用户的 4 个操作增删改查。

public class UserDto {  private String name;  private String pwd;  public String getName() {      return name;  }  public void setName(String name) {      this.name = name;  }  public String getPwd() {      return pwd;  }  public void setPwd(String pwd) {      this.pwd = pwd;  }}

/** * RESTful API 格调示例 对资源 user 进行操作 * 本示例没有应用数据库，也没有应用 service 类来辅助实现，所有操作在本类中实现 * */@Api(tags = "霍格沃兹测试学院-用户治理模块", hidden = true)@RestController@RequestMapping("/api/user")public class HogwartsTestUserController {    /**     * 查问用户列表，返回一个JSON数组     * */    @ApiOperation("查问用户列表")    @GetMapping("/users")    @ResponseStatus(HttpStatus.OK)    public Object getUsers(){        List<UserDto> list = getData();        return list;    }    /**     * 查问用户信息，返回一个新建的JSON对象     * */    @ApiOperation("查问用户信息")    @GetMapping("/users/{id}")    @ResponseStatus(HttpStatus.OK)    public Object getUser(@PathVariable("id") Long id){        if(Objects.isNull(id)){            return null;        }        List<UserDto> list= getData();        UserDto userDto = getUserDto(id, list);        return userDto;    }    /**     * 新增用户     * */    @ApiOperation("新增用户")    @PostMapping("/users")    @ResponseStatus(HttpStatus.CREATED)    public Object addUser(@RequestBody UserDto user){        List<UserDto> list= getData();        list.add(user);//模仿向列表中减少数据        return user;    }    /**     * 编辑用户     * */    @ApiOperation("编辑用户")    @PutMapping("/users/{id}")    @ResponseStatus(HttpStatus.CREATED)    public Object editUser(@PathVariable("id") Long id,@RequestBody UserDto user){        List<UserDto> list = getData();        for (UserDto userDto:list) {            if(id.equals(userDto.getId())){                userDto = user;                break;            }        }        return user;    }    /**     * 删除用户     * */    @ApiOperation("删除用户")    @DeleteMapping("/users/{id}")    @ResponseStatus(HttpStatus.NO_CONTENT)    public Object deleteUser(@PathVariable("id") Long id){        List<UserDto> list = getData();        UserDto userDto = getUserDto(id, list);        return  userDto;    }    /**     * 模仿数据     * */    private List<UserDto> getData(){        List<UserDto> list=new ArrayList<>();        UserDto userDto = new UserDto();        userDto.setId(1L);        userDto.setName("admin");        userDto.setPwd("admin");        list.add(userDto);        userDto = new UserDto();        userDto.setId(2L);        userDto.setName("HogwartsTest1");        userDto.setPwd("HogwartsTest1");        list.add(userDto);        userDto = new UserDto();        userDto.setId(3L);        userDto.setName("HogwartsTest2");        userDto.setPwd("HogwartsTest2");        list.add(userDto);        userDto = new UserDto();        userDto.setId(4L);        userDto.setName("HogwartsTest3");        userDto.setPwd("HogwartsTest3");        list.add(userDto);        return  list;    }    /**     *  模仿依据id查问列表中的数据     * @param id     * @param list     * @return     */    private UserDto getUserDto( Long id, List<UserDto> list) {        UserDto UserDto = null;        for (UserDto user : list) {            if (id.equals(user.getId())) {                UserDto = user;                break;            }        }        return UserDto;    }}

获取全副资源获取所有用户

GET http://127.0.0.1:8081/api/use...

响应参数

[  {    "id": 1,    "name": "admin",    "pwd": "admin"  },  {    "id": 2,    "name": "HogwartsTest1",    "pwd": "HogwartsTest1"  },  {    "id": 3,    "name": "HogwartsTest2",    "pwd": "HogwartsTest2"  },  {    "id": 4,    "name": "HogwartsTest3",    "pwd": "HogwartsTest3"  }]

获取单个资源获取用户

GET http://127.0.0.1:8081/api/use...

新增一个资源新增一个用户

POST http://127.0.0.1:8081/api/use...

申请参数

{  "id": 4,  "name": "HogwartsTest5",  "pwd": "HogwartsTest5"}

编辑更新一个资源

PUT http://127.0.0.1:8081/api/use...

申请参数

{  "name": "HogwartsTest6",  "pwd": "HogwartsTest6"}

删除一个资源

DELETE http://127.0.0.1:8081/api/use...

上面介绍一些 Spring Boot 罕用配置项，通过这些罕用配置项，咱们能够批改 Spring Boot 的一些默认配置。
批改服务默认端口：

server:  port: 8093

指定服务名称：

spring:  application:    name: aitest

多环境配置

spring:  profiles:    active: dev

如上图新建 application-dev.yml、application-test.yml、application-uat.yml、application-prod.yml 四套配置文件环境，咱们在四套配置文件中将设置服务端口号别离设置为 8091/8092/8093/8094。

而后启动服务，能够看到服务的端口号会和 application.yml 中激活的环境配置信息统一。

RESTful API简介

设计规范

Spring Boot 实现 RESTful API