Swagger-ui用法

导入Maven依赖

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

接口文档生成类

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket UserApi() {
        return new Docket(DocumentationType.SWAGGER_2)
       			 // 当前的ip 和 端口号  为那个服务产生 接口文档
       			 //访问地址http://localhost:666/swagger-ui.html 
                //.host("127.0.0.1:666") 
                //apiInfo指定测试文档基本信息，这部分将在页面展示
                .apiInfo(UserApiInfo())
                .select()
                //apis() 控制哪些接口暴露给swagger，
                // RequestHandlerSelectors.any() 所有都暴露
                // RequestHandlerSelectors.basePackage("com.calf.controller.portal")  指定包位置
				//.apis(RequestHandlerSelectors.any())
				// 对应接口类
                .apis(RequestHandlerSelectors.basePackage("com.calf.controller.user"))
                .paths(PathSelectors.any())
                .build()
                .groupName("用户中心");
    }

    //基本信息，页面展示
    private ApiInfo UserApiInfo() {
        return new ApiInfoBuilder()
                .title("测试项目标题")
                .description("接口描述")
                //联系人实体类
                .contact(
                        new Contact("名字", "网址", "邮箱")
                )
                //版本号
                .version("1.0.0-SNAPSHOT")
                .build();
    }
}

单一接口配置(对应Controller)

@RestController
@Api(value = "@Api 修饰整个类，描述Controller的作用")
public class SwaggerController {
    @GetMapping("/hello/{name}")
    @ApiOperation(value = "描述一个类的方法，或者说是一个接口")
    public String hello(
            @ApiParam(value = "单个参数的描述",example = "举一个例子")@PathVariable(value = "name") String name){
        return "hello" + name;
    }

}