Swagger

1.在springboot 2.1.0release 版本下：

swagger2版本

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
</dependency>
2.主要配置类：

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author:Frankiegg
 * @date:2018/9/12
 * @project:bee
 * @Modified By:
 **/
@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.sinosoft.sss"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("开放式销售平台回访查询模块接口文档")
                //创建人
                .contact(new Contact("Frankiegg", "http://www.baidu.com", ""))
                //版本号
                .version("1.0")
                //描述
                .description("包括回访查询接口和保单详情查询接口")
                .build();
    }
}
3.主要使用方式

Swagger 是一个用于构建、文档化和测试 RESTful API 的强大工具。下面是一些常用的 Swagger 注解和使用示例：

1. @Api：用于声明一个控制器类为 Swagger 文档的一部分。

@Api(tags = "User API", description = "Operations related to users")
@RestController
@RequestMapping("/api/users")
public class UserController {
    // ...
}

2. @ApiOperation：用于描述一个操作或接口。

@ApiOperation(value = "Get user by ID", response = User.class)
@GetMapping("/{id}")
public User getUserById(@PathVariable Long id) {
    // ...
}

3. @ApiParam：用于给操作的参数添加描述。

@GetMapping("/{id}")
public User getUserById(@ApiParam(value = "User ID", required = true) @PathVariable Long id) {
    // ...
}

4. @ApiResponse：用于描述一个操作的返回结果。

@ApiResponse(code = 200, message = "Success", response = User.class)
@GetMapping("/{id}")
public User getUserById(@PathVariable Long id) {
    // ...
}

5. @ApiResponses：用于描述一组操作的返回结果。

@ApiResponses(value = {
        @ApiResponse(code = 200, message = "Success", response = User.class),
        @ApiResponse(code = 404, message = "User not found")
})
@GetMapping("/{id}")
public User getUserById(@PathVariable Long id) {
    // ...
}

6. @ApiModel：用于描述一个数据模型。

@ApiModel(description = "User create request")
public class CreateUserRequest {
    // ...
}

7. @ApiModelProperty：用于给数据模型的属性添加描述。

@ApiModel(description = "User")
public class User {
    @ApiModelProperty(value = "User ID", example = "123", required = true)
    private Long id;
    // ...
}

以上只是 Swagger 注解的一小部分，还有更多可用于定制化和文档编写的注解。详细的注解用法和示例可以查看 Swagger 官方文档。