SpringBoot后端篇(四)集成Swagger

mac2024-05-20  38

测试代码运行

SysUserMapper.xml中写入sql

<select id="selectAll" resultMap="BaseResultMap"> select <include refid="Base_Column_List" /> from sys_user </select>

dao层的SysUserMapper添加selectAll 

package com.example.springboot.dao; import com.example.springboot.model.SysUser; import java.util.List; public interface SysUserMapper { List<SysUser> selectAll(); /** * This method was generated by MyBatis Generator. * This method corresponds to the database table sys_user * * @mbggenerated */ int deleteByPrimaryKey(Long id); /** * This method was generated by MyBatis Generator. * This method corresponds to the database table sys_user * * @mbggenerated */ int insert(SysUser record); /** * This method was generated by MyBatis Generator. * This method corresponds to the database table sys_user * * @mbggenerated */ int insertSelective(SysUser record); /** * This method was generated by MyBatis Generator. * This method corresponds to the database table sys_user * * @mbggenerated */ SysUser selectByPrimaryKey(Long id); /** * This method was generated by MyBatis Generator. * This method corresponds to the database table sys_user * * @mbggenerated */ int updateByPrimaryKeySelective(SysUser record); /** * This method was generated by MyBatis Generator. * This method corresponds to the database table sys_user * * @mbggenerated */ int updateByPrimaryKey(SysUser record); }

创建service,serviceImpl以及controller目录

SysUserService 

package com.example.springboot.service; import com.example.springboot.model.SysUser; import java.util.List; public interface SysUserService { List<SysUser> findAll(); }

SysUserServiceImpl

package com.example.springboot.service.serviceImpl; import com.example.springboot.dao.SysUserMapper; import com.example.springboot.model.SysUser; import com.example.springboot.service.SysUserService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import java.util.List; @Service public class SysUserServiceImpl implements SysUserService { @Autowired private SysUserMapper sysUserMapper; @Override public List<SysUser> findAll() { return sysUserMapper.selectAll(); } }

SysUserController 

package com.example.springboot.controller; import com.example.springboot.service.SysUserService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("user") public class SysUserController { @Autowired private SysUserService sysUserService; @GetMapping(value="/findAll") public Object findAll() { return sysUserService.findAll(); } }

然后启动,访问http://localhost:8080/user/findAll

接下来为了更好的测试,就用Swagger

集成Swagger

pom添加依赖

<!-- swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.8.0</version> </dependency>

在config目录下新建Swagger类

package com.example.springboot.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class Swagger { @Bean public Docket createRestApi(){ return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()).build(); } private ApiInfo apiInfo(){ return new ApiInfoBuilder() .title("Kitty API Doc") .description("This is a restful api document of Kitty.") .version("1.0") .build(); } }

启动服务,访问http://localhost:8080/swagger-ui.html#/,出现下面页面,即集成Swagger成功

 

最新回复(0)