swagger的添加

一.swagger的添加可以让接口调用情况更加明了

二.添加相关依赖和配置文件；

依赖:

        <!--  集成 swagger2 start-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

 

添加相关配置:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
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 Swagger2Configuration extends WebMvcConfigurerAdapter{
	
     @Override
     public void addResourceHandlers(ResourceHandlerRegistry registry) {
         registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
         registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
     }

	  @Bean
	    public Docket createRestApi() {
	        return new Docket(DocumentationType.SWAGGER_2)
	                .apiInfo(apiInfo())
	                .select()
	                //为当前包路径
	                .apis(RequestHandlerSelectors.basePackage("com.qf"))
	                .paths(PathSelectors.any())
	                .build();
	    }
	    //构建 api文档的详细信息函数
	    private ApiInfo apiInfo() {
	    	return new ApiInfoBuilder()
	                //页面标题
	                .title("Market Channel API")
	                //创建人
	                .contact(new Contact("ddyin", "https://www.dianrong.com/", "ddyin@163.com"))
	                //版本号
	                .version("1.0")
	                //描述
	                .description("API 描述")
	                .build();
	    }

}

 

三.启动项目，即可看到相关接口调用信息等:

转载于:https://my.oschina.net/u/3110937/blog/1624371