swagger在springboot中的简单使用

Swagger在springboot上的配置

第一步 导入相关依赖包

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

第二步 创建Swagger2类

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

@Configuration
@EnableSwagger2
public class Swagger2 {
        @Bean
        public Docket createDocketApi(){
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("xxx"))//需要扫描的包
                    .paths(PathSelectors.any())
                    .build();
        }

        //  API 信息
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("xxx")//标题
                    .description("xxx API 接口文档")//描述
                    .version("1.0")
                    .build();
        }
}

-Docket : 是用来生成文档的函数，其下有包含该调用的方法
-apiInfo：是用来描述文档的基本信息
-select：用来控制哪些接口暴露给 Swagger 来展现
-apis: 会扫描该包下所有的定义controller的API
-paths： 任何url请求文档

第三步
创建controller

@Api
@RestController
public class SwaggerTest1 {
    @ApiOperation("json数据的测试")
    @RequestMapping(value = "/json",method = RequestMethod.GET)
    public ResultData<String> getResultData(){
        return new ResultData<>(200,"成功","1231");
    }
}

@Api 描述类的作用

@ApiOperation 描述类的方法的作用

@ApiParam 描述类方法参数的作用

@ApiModel 描述对象的作用

@ApiModelProperty 描述对象里字段的作用

最后一步
进入网址 http://localhost:端口号/swagger-ui.html进入界面