swagger使用

  <!-- swagger 生成接口文档 用doc.html好点-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <!--此处是 /swagger-ui.html-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>
            <!--这里是doc.html-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
        </dependency>

//生成接口文档
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        //http://ip地址:端口/项目名/swagger-ui.html#/      http://ip地址:端口/项目名/doc.html#/
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("项目名称") //网站标题
                .description("项目名称swagger RESTful APIs......") //网站描述
                .version("1.0") //版本
                .contact(new Contact("张三","https://",".com")) //联系人
                .license("The Apache License") //协议
                .licenseUrl("http://www.baidu.com") //协议url
                .build();

        return new Docket(DocumentationType.SWAGGER_2) //swagger版本
                .pathMapping("/")
                .select()
                //扫描那些controller
                .apis(RequestHandlerSelectors.basePackage("com.zhch.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo);
    }
}

@RestController
//value 功能（页面不显示）  tags 总功能标签（显示）
@Api(value="测试类数值",tags = "测试类数值1")
public class Zj2Controller {

    @Resource
    private IZj2Service zj2Service;

    //ApiOperation  value  标签名称 notes 接口描述    response 响应哪种类型
    @ApiOperation(value="模型总表信息",notes="模型总表信息,分页查询",response=String.class)
    // ApiImplicitParam  name 需要哪种参数  value 参数描述  required 是否是必须填写  dataType 数值类型
    @ApiImplicitParams({
            @ApiImplicitParam(name = "page", value = "分页的起始页", required = true, dataType = "String"),
            @ApiImplicitParam(name = "limit", value = "每页显示的数量", required = true, dataType = "String")
    })
    @GetMapping("/select/one")
    public Result sub(@RequestParam(value = "name") @NotNull String name){
        return Result.success(zj2Service.getName(new JSONArray()));
    }