SpringBoot——整合Swagger2构建Restful风格的文档

1.概述

(1).SpringBoot创建RESTFUL风格接口，也称为表述性状态转移。如：GET、POST、PUT、DELETE等

(2).使用swagger2构建restful接口测试。

优点：

• 可以生成文档形式的api并提供给不同团队
• 便于自测，也便于领导查询任务量
• 无需过度冗余的word文档

2.pom.xml

web场景+数据库连接+连接池+swagger2

        <!-- web场景  -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--导入Lombok的依赖-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!-- 数据库连接 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.25</version>
        </dependency>
        <!--导入SpringBoot整合Mybatis相关依赖-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.0.0</version>
        </dependency>
        <!-- druid数据库连接池 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.10</version>
        </dependency>
        <!--增加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>

3.application.yml

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/test1?serverTimezone=GMT%2B8&&useUnicode=true&&characterEncoding=UTF-8
    type: com.alibaba.druid.pool.DruidDataSource
    username: root
    password: 113846
    driver-class-name: com.mysql.jdbc.Driver

4.bean

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String username;
    private Integer age;
}

@Data：生成get、set方法

@AllArgsConstructor：容器启动生成有参构造方法

@NoArgsConstructor：容器启动生成无参构造方法

5.mapper

@Mapper
public interface UserDao {
    @Insert("insert into user(username,age)values(#{username},#{age})")
    public void insert(User user);

    @Update("update user set username=#{username},age=#{age} where id=#{id}")
    public void updateUser(User user);

    @Delete("delete from user where id=#{id}")
    public void delete(Long id);

    @Select("select * from user")
    public List<User> findAll();

    @Select("select * from user where id=#{id}")
    public User findUserById(Long id);
}

Mapper和Repository的区别：

配置文件配置sql，Repository需要在在启动类中配置mapperscan扫描地址然后才能扫描生成bean注入到service，Mapper只要在xml配置文件中存在namespace的接口访问就能生成bean注入到service。

6.service和serviceImpl

@Service
public interface UserService {
    public List<User> getuserList();

    public void createUser(User user);

    public User getUserById(Long id);

    public void updateUser(Long id, User user);

    public void deleteUserById(Long id);
}

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserDao userDao;

    @Override
    public List<User> getuserList() {
        return userDao.findAll();
    }

    @Override
    public void createUser(User user) {
        userDao.insert(user);
    }

    @Override
    public User getUserById(Long id) {
        return userDao.findUserById(id);
    }

    @Override
    public void updateUser(Long id, User user) {
        user.setId(id);
        userDao.updateUser(user);
    }

    @Override
    public void deleteUserById(Long id) {
        userDao.delete(id);
    }

@Service("userService")：控制反转，依赖注入。spring去创建实例

7.controller

@RestController //点进去看带有@Controller和@ResponseBody，自带有，下边方法就不用导了
@RequestMapping("/user")
public class UserController {

    List<User> listUser = new ArrayList<User>();

    //查询所有用户
    @GetMapping("/")
    //给方法增加说明，notes：备注
    @ApiOperation(value = "查询所有的用户信息", notes = "查询用户列表")
    public List<User> getUserList() {
        return listUser;
    }

    //增添用户
    @PostMapping("/")
    @ApiOperation(value = "新增用户", notes = "保存用户")
    //给方法的参数增加注解，name：参数名称，dataType参数类型，value：参数功能
    @ApiImplicitParams({
            @ApiImplicitParam(name = "user", dataType = "User", value = "要保存的用户对象")
    })
    public String createUser(User user) {
        listUser.add(user);
        return "success";
    }

    
    //根据id查询用户
     
    @GetMapping("/{id}")
    @ApiOperation(value = "查询指定id用户的信息", notes = "单个查询")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户的编号")
    })
    public User getUserById(@PathVariable("id") Long id) {
        for (User user : listUser) {
            if (user.getId() == id) {
                return user;
            }
        }

        return null;
    }

    //更新用户，根据id
    @PutMapping("/{id}")
    @ApiOperation(value = "更新指定id的用户信息", notes = "修改指定用户的相关信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户的Id", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "user", value = "用户的详细信息对象", required = true, dataType = "User")
    })
    public String updateUser(@PathVariable("id") Long id, User user) {
        for (User user1 : listUser) {
            if (user1.getId() == id) {
                user1.setUsername(user.getUsername());
                user1.setAge(user.getAge());
            }
        }

        return "success";
    }

    //根据id删除用户
    @ApiOperation(value = "删除指定id的用户信息", notes = "删除指定用户")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户的Id", required = true, dataType = "Long")
    })
    @DeleteMapping("/{id}")
    public String deleteUser(@PathVariable("id") Long id) {
        listUser.remove(getUserById(id));
        return "success";
    }
}

@RestController：复合注解，封装@Controller和@ResponseBody

@RequestMapping：配置请求路径

@ApiOperation：配置方法该restful接口请求的功能提示，notes备注方法功能页面展示

@ApiImplicitParams：配置方法请求参数

8.config

//指定需要生成API文档的类所在的包路径
//@ComponentScan(basePackages = {"路径"})
//声明一个配置类
@Configuration
//swagger2启动注解
@EnableSwagger2
public class SwaggerConfig {

    //生成文档相关信息
    //标题  描述  维护者  联系人  版本  构建
    public ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("学习SpringBoot整合Swagger2构建Restful风格的文档").description("初次使用").termsOfServiceUrl("维护者").contact("张敏").version("1.0").build();
    }

    @Bean
    public Docket createRestApiInfo() {
        //文档类型为SWAGGER_2  生成这个文档的基本api信息（拿上边定义的信息构建api文档）  选中这个文档  将来给那个包下的控制器生成文档（给controller下的所有类生成restful风格的文档） 给这个路径的所有都生成 构建
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.openlab.controller")).paths(PathSelectors.any()).build();
    }
}

9.展示结果

路径：http://127.0.0.1:8080/swagger-ui.html#/

9.1页面结果

9.2RESTFUL风格结果

9.2.1方法结果