快速开始

Java开发

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

Maven中引入Jar包

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

  1. <dependency>
  2.  <groupId>io.springfox</groupId>
  3.  <artifactId>springfox-swagger2</artifactId>
  4.  <version>2.9.2</version>
  5. </dependency>

然后引入SwaggerBootstrapUi的jar包

  1. <dependency>
  2.   <groupId>com.github.xiaoymin</groupId>
  3.   <artifactId>swagger-bootstrap-ui</artifactId>
  4.   <version>${lastVersion}</version>
  5. </dependency>

编写Swagger2Config配置文件

Swagger2Config配置文件如下：

  1. @Configuration
  2. @EnableSwagger2
  3. public class SwaggerConfiguration {
  5.  @Bean
  6.  public Docket createRestApi() {
  7.      return new Docket(DocumentationType.SWAGGER_2)
  8.      .apiInfo(apiInfo())
  9.      .select()
  10.      .apis(RequestHandlerSelectors.basePackage("com.bycdao.cloud"))
  11.      .paths(PathSelectors.any())
  12.      .build();
  13.  }
  15.  private ApiInfo apiInfo() {
  16.      return new ApiInfoBuilder()
  17.      .title("swagger-bootstrap-ui RESTful APIs")
  18.      .description("swagger-bootstrap-ui")
  19.      .termsOfServiceUrl("http://localhost:8999/")
  20.      .contact("developer@mail.com")
  21.      .version("1.0")
  22.      .build();
  23.  }
  24. }

访问地址

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的相关配置实例如下：
  1. <!---other settings-->
  2. <property name="filterChainDefinitions">    
  3.     <value>     
  4.         /swagger-resources = anon
  5.         /v2/api-docs = anon
  6.         /v2/api-docs-ext = anon
  7.         /doc.html = anon
  8.         /webjars/** = anon
  10.         //others....
  11.     </value>    
  12. </property>

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

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

  1. @SpringBootApplication
  2. @ConditionalOnClass(SpringfoxWebMvcConfiguration.class)
  3. public class SwaggerBootstrapUiDemoApplication  implements WebMvcConfigurer{
  5.     @Override
  6.     public void addResourceHandlers(ResourceHandlerRegistry registry) {
  7.         registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
  8.         registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
  9.     }
  10. }

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

  1. <servlet>
  2.    <servlet-name>cmsMvc</servlet-name>
  3.    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  4.    <init-param>
  5.    <param-name>contextConfigLocation</param-name>
  6.    <param-value>classpath:config/spring.xml</param-value>
  7.    </init-param>
  8.    <load-on-startup>1</load-on-startup>
  9. </servlet>
  10. <!--默认配置,.htm|.do|.json等等配置-->
  11. <servlet-mapping>
  12.     <servlet-name>cmsMvc</servlet-name>
  13.      <url-pattern>*.htm</url-pattern>
  14. </servlet-mapping>
  15. <!-- 配置swagger-bootstrap-ui的url请求路径-->
  16. <servlet-mapping>
  17.    <servlet-name>cmsMvc</servlet-name>
  18.    <url-pattern>/v2/api-docs</url-pattern>
  19. </servlet-mapping>
  20. <servlet-mapping>
  21.    <servlet-name>cmsMvc</servlet-name>
  22.    <url-pattern>/swagger-resources</url-pattern>
  23. </servlet-mapping>
  24. <servlet-mapping>
  25.    <servlet-name>cmsMvc</servlet-name>
  26.    <url-pattern>/v2/api-docs-ext</url-pattern>
  27. </servlet-mapping>

其他语言

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