Swagger配置与使用

1、导入两个依赖

 
        
            io.springfox
            springfox-swagger2
            2.9.2
        
        
        
            com.github.xiaoymin
            swagger-bootstrap-ui
            1.9.6

Swaggeui推荐使用第三方的依赖

2、在项目中使用java配置类的方式配置swagger

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;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    

    
    @Bean
    public Docket createRestApi(){
        return new Docket(documentationType.SWAGGER_2) //指定文档风格
                .apiInfo(apiInfo())
                .select() //选择生成策略
                .apis(RequestHandlerSelectors.basePackage("com.zstudyj.controller")) //选择要生成接口文档的类
                .paths(PathSelectors.any())
                .build();
    }

    
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("xx商城接口文档") //添加标题
                .description("xx商城接口文档") //添加描述
                .contact(new Contact("zxj","http:localhost:8081/doc.html","xxxx@xxxx.com"))
                .version("v 2.0.1")
                .build();
    }

}

配置完成，访问接口 http://ip:port/doc.html

3、Swagger注解说明

swagger提供了一套注解，可以对每个接口进行详细说明

@Api 类注解,在控制器类添加此注解，可以对控制器类进行功能说明

效果

@ApiOperation 方法注解,在方法上添加此注解，可以对方法进行功能说明

效果

@ApiImplicitParams和@ApiImplicitParam参数注解，说明参数的类型，名称，是否必须，默认值等

效果

@ApiModel和@ApiModelProperty当接口参数和返回值为对象类型时,在实体类中添加注解说明

Swagger配置与使用

Java相关栏目本月热门文章