swagger接口文档的使用

1.访问地址为项目路径+swagger-ui.html

2.swagger的配置使用

1. 配置swagger的Docket和ApiInfo

@Configuration
@EnableSwagger2  #配置swagger
public class SwaggerConfiguration {

	@Value("${swagger.enable}")  #配置文件里面设置为true 表示开启swagger
	private boolean enableSwagger;
    @Bean
    public Docket config() {
    	#配置文档基本信息
        return new Docket(DocumentationType.SWAGGER_2) #swagger的文档类型
                .apiInfo(apiInfo())  #api的头信息
                .enable(enableSwagger)  
                .useDefaultResponseMessages(false)  #不使用默认的响应信息
                .select()
                .apis(RequestHandlerSelectors.basePackage("ins"))  #注解扫描包的位置
                .paths(PathSelectors.any())
                .build();
    }

	#文档的头信息
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("续保系统表API文档（测试）")
                .description("每个表五个方法：查询表所有数据，根据id查询，根据id删除，根据id创建，根据id修改.")
                .termsOfServiceUrl("http://www.baidu.com")
                .contact(new Contact("", "访问地址", "联系方式"))
                .version("1.0")
                .build();
    }
}

2. 在需要添加的接口上面添加相应的注解
@Api(value=“XX跟踪controller”,tags={“XX跟踪操作接口”}) value - 字段说明 tags- 注释说明这个类

@ApiOperation(value = “testSwagger-value”, notes = “这个是swagger的描述”, response = String.class)
value 接口文档的值显示在页面上 notes 接口文档的描述 response相应类型

@ApiImplicitParams({ @ApiImplicitParam(name = “policyNo”, value = “test-policyNo”, required = true, dataType = “String”),
@ApiImplicitParam(name = “mobile”, value = “test-mobile”, required = true, dataType = “String”),
@ApiImplicitParam(name = “msg”, value = “test-msg”, required = true, dataType = “String”) })

@ApiImplicitParams请求参数集合
@ApiImplicitParam请求的参数
name 请求的名字 value 请求的描述 required 参数必须传 dataType 参数类型

3. 这是接口文档所以 必须要加上@RequestMapping文档才会检测以及显示在文档页面上