swagger-bootstrap-ui 介绍和使用

Java开发

如果你是一名Java开发工程师,那么使用swagger-bootstrap-ui将会非常简单,只需要在原使用的基础上,添加swagger-bootstrap-ui的maven引用jar包即可

knife4j的使用方式请前往Spring Boot中使用Knife4j

#Maven中引入Jar包

由于是springfox-swagger的增强UI包,所以基础功能依然依赖Swagger,springfox-swagger的jar包必须引入

 io.springfox
 springfox-swagger2
 2.9.2

然后引入SwaggerBootstrapUi的jar包

  com.github.xiaoymin
  swagger-bootstrap-ui
  ${lastVersion}

#编写Swagger2Config配置文件

Swagger2Config配置文件如下：

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

 @Bean
 public Docket createRestApi() {
     return new Docket(DocumentationType.SWAGGER_2)
     .apiInfo(apiInfo())
     .select()
     .apis(RequestHandlerSelectors.basePackage("com.bycdao.cloud"))
     .paths(PathSelectors.any())
     .build();
 }

 private ApiInfo apiInfo() {
     return new ApiInfoBuilder()
     .title("swagger-bootstrap-ui RESTful APIs")
     .description("swagger-bootstrap-ui")
     .termsOfServiceUrl("http://localhost:8999/")
     .contact("[email protected]")
     .version("1.0")
     .build();
 }
}

#访问地址

swagger-bootstrap-ui默认访问地址是：http://${host}:${port}/doc.html

#注意事项

Springfox-swagger默认提供了两个Swagger接口,需要开发者放开权限(如果使用shiro权限控制框架等)，如果使用SwaggerBootstrapUi的增强功能,还需放开增强接口地址,所以，放开的权限接口包括3个，分别是：

• /swagger-resources:Swagger的分组接口
• /v2/api-docs?group=groupName:Swagger的具体分组实例接口,返回该分组下所有接口相关的Swagger信息
• /v2/api-docs-ext?group=groupName:该接口是SwaggerBootstrapUi提供的增强接口地址,如不使用UI增强,则可以忽略该接口

Shiro的相关配置实例如下：

    
         
        /swagger-resources = anon
        /v2/api-docs = anon
        /v2/api-docs-ext = anon
        /doc.html = anon
        /webjars/** = anon
        
        //others....
        

SpringBoot中访问doc.html报404的解决办法

实现SpringBoot的WebMvcConfigurer接口，添加相关的ResourceHandler,代码如下：

@SpringBootApplication
@ConditionalOnClass(SpringfoxWebMvcConfiguration.class)
public class SwaggerBootstrapUiDemoApplication  implements WebMvcConfigurer{

	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
		registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
	}
}

使用SpringMvc的朋友.在web.xml中配置了DispatcherServlet,则需要追加一个url匹配规则,如下

   cmsMvc
   org.springframework.web.servlet.DispatcherServlet
   
   contextConfigLocation
   classpath:config/spring.xml
   
   1



	cmsMvc
 	*.htm



   cmsMvc
   /v2/api-docs


   cmsMvc
   /swagger-resources


   cmsMvc
   /v2/api-docs-ext

#其他语言

如果使用的是其他语言的话,想使用swagger-bootstrap-ui,建议使用她的前端分离版本swagger-bootstrap-ui-front,具体可参考前端分离的文档说明