后端项目第六弹之Controller测试
一、修改UserController.java内容如下:
package com.mq.system.controller; import com.mq.system.entity.User; import com.mq.system.service.UserService; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import javax.annotation.Resource; import java.util.List; /** * <p> * 用户表 前端控制器 * </p> * * @author mq * @since 2022-11-07 */ @RestController @RequestMapping("/admin/system/user") public class UserController { // 注入service对象 @Resource private UserService userService; @GetMapping("/list") public List<User> list() { return userService.list(); } }
二、测试Controller接口
http://localhost:8081/admin/system/user/list
三、集成Swagger2(api文档)
3.1 引入依赖
在common模块的pom.xml中引入以下依赖:
<!-- swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> </dependency> <!-- 美化swagger文档 --> <dependency> <groupId>com.github.xiaoymin</groupId> <!--使用Swagger2--> <artifactId>swagger-bootstrap-ui</artifactId> </dependency>
3.2 swagger2配置文件
在common模块的config包中新建SwaggerConfig.java文件,并写入以下内容:
package com.mq.system.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.ParameterBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.schema.ModelRef; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.service.Parameter; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; import java.util.ArrayList; import java.util.List; /** * @author MaQian * @Description Swagger配置类 * @Data 2022/11/1 17:37:35 * @Modified by */ @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket adminApiConfig() { // 添加请求头信息 List<Parameter> pars = new ArrayList<>(); ParameterBuilder tokenPar = new ParameterBuilder(); tokenPar.name("token") .description("用户token") .defaultValue("") .modelRef(new ModelRef("string")) .parameterType("header") .required(false) .build(); pars.add(tokenPar.build()); return new Docket(DocumentationType.SWAGGER_2) .groupName("登录模块") .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.mq.system.controller")) .paths(PathSelectors.regex("/admin/.*")) .build() .globalOperationParameters(pars); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("系统后端接口") .description("系统后端接口") .contact(new Contact("xx","暂无","xxxx@qq.com")) .version("1.0") .build(); } }
3.3 Controller层添加Swagger注解
package com.mq.system.controller; import com.mq.system.entity.User; import com.mq.system.service.UserService; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import org.springframework.web.bind.annotation.*; import javax.annotation.Resource; import java.util.List; /** * <p> * 用户表 前端控制器 * </p> * * @author mq * @since 2022-11-07 */ @Api(tags = "用户管理") @RestController @RequestMapping("/admin/system/user") public class UserController { // 1、注入Service对象 @Resource private UserService userService; // 2、编写接口 @ApiOperation(value = "获取用户列表",notes = "返回用户列表信息") @GetMapping("/list") public List<User> list() { List<User> userList = userService.list(); return userList; } }
3.4 controller测试
http://localhost:8800/doc.html
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
如需转载请保留出处:https://bianchenghao.cn/bian-cheng-ri-ji/44155.html