Swagger 基本使用

一、 导入相应的jar包

					 

        io.springfox
        springfox-swagger2
        2.5.0
    
 				   
    
        io.springfox
        springfox-swagger-ui
        2.5.0
    

二、 配置Swaggerconfig 类 在com.***.config下

package com.zhiyou100.config;
import springfox.documentation.service.Contact;
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 SwaggerConfig {
	  @Bean
	    public Docket createRestApi() {
	        return new Docket(DocumentationType.SWAGGER_2)
	                .apiInfo(apiInfo())
	                .select()
	                //为当前包/ controller路径
	                .apis(RequestHandlerSelectors.basePackage("com.zhiyou100.controller"))
	                .paths(PathSelectors.any())
	                .build();
//	        return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
	    }
	    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
	    private ApiInfo apiInfo() {
	        return new ApiInfoBuilder()
	                //页面标题
	                .title("Spring Boot 使用 Swagger2 构建RESTful API")
	                //创建人
	                .contact(new Contact("Bryan", "http://blog.bianxh.top/", ""))
	                //版本号
	                .version("1.0")
	                //描述
	                .description("API 描述")
	                .build();
	    }
}

使用：

网址: http://localhost:8080/swagger-ui.html

@Api(description="用户操作接口")
标题名字为用户操作接口

@ApiOperation(value = “查询全部”,notes=“查询所有的user”)

@ApiImplicitParam(name = “id查询”,value=“描述”,paramType = “query”, required = true, dataType = “Integer”)类型