admin管理员组

文章数量:1026989

springfox

springfox-swagger-ui 3.0之后就不会配置了

在3.0中,访问地址URL变了。

  • http://地址:端口/项目名/swagger-ui/index.html
  • http://地址:端口/项目名/swagger-ui/

springboot

maven项目引入

 <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>3.0.0</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>3.0.0</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</version></dependency>

gradle项目引入

    //.springfox/springfox-swagger2implementation group: 'io.springfox', name: 'springfox-swagger2', version: '3.0.0'//.springfox/springfox-swagger-uiimplementation group: 'io.springfox', name: 'springfox-swagger-ui', version: '3.0.0'//.springfox/springfox-boot-starterimplementation group: 'io.springfox', name: 'springfox-boot-starter', version: '3.0.0'

SwaggerConfig.java 配置


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.*;
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 implements WebMvcConfigurer {@Beanpublic Docket createRestApi() {ApiInfo apiInfo =new ApiInfoBuilder().title("日志管理系统API").description("日志管理系统采用SpringBoot开发,API文档集成Swagger").version("1.0").contact(new Contact("余静", "", "3373217@qq.com")).license("我的首页").licenseUrl("").build();return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).select().apis(RequestHandlerSelectors.basePackage("com.hn.logmanage.Controller")).paths(PathSelectors.any()).build();}@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler( "/swagger-ui/**").addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/").resourceChain(false);}@Overridepublic void addViewControllers(ViewControllerRegistry registry) {registry.addViewController( "/swagger-ui/").setViewName("forward:" +  "/swagger-ui/index.html");}
}

这是效果图

这是官方说明文档

如果帮助到了大家,点个赞或者来个关注。

springfox

springfox-swagger-ui 3.0之后就不会配置了

在3.0中,访问地址URL变了。

  • http://地址:端口/项目名/swagger-ui/index.html
  • http://地址:端口/项目名/swagger-ui/

springboot

maven项目引入

 <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>3.0.0</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>3.0.0</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</version></dependency>

gradle项目引入

    //.springfox/springfox-swagger2implementation group: 'io.springfox', name: 'springfox-swagger2', version: '3.0.0'//.springfox/springfox-swagger-uiimplementation group: 'io.springfox', name: 'springfox-swagger-ui', version: '3.0.0'//.springfox/springfox-boot-starterimplementation group: 'io.springfox', name: 'springfox-boot-starter', version: '3.0.0'

SwaggerConfig.java 配置


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.*;
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 implements WebMvcConfigurer {@Beanpublic Docket createRestApi() {ApiInfo apiInfo =new ApiInfoBuilder().title("日志管理系统API").description("日志管理系统采用SpringBoot开发,API文档集成Swagger").version("1.0").contact(new Contact("余静", "", "3373217@qq.com")).license("我的首页").licenseUrl("").build();return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).select().apis(RequestHandlerSelectors.basePackage("com.hn.logmanage.Controller")).paths(PathSelectors.any()).build();}@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler( "/swagger-ui/**").addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/").resourceChain(false);}@Overridepublic void addViewControllers(ViewControllerRegistry registry) {registry.addViewController( "/swagger-ui/").setViewName("forward:" +  "/swagger-ui/index.html");}
}

这是效果图

这是官方说明文档

如果帮助到了大家,点个赞或者来个关注。

本文标签: springfox