开源中国

我们不支持 IE 10 及以下版本浏览器

It appears you’re using an unsupported browser

为了获得更好的浏览体验,我们强烈建议您使用较新版本的 Chrome、 Firefox、 Safari 等,或者升级到最新版本的IE浏览器。 如果您使用的是 IE 11 或以上版本,请关闭“兼容性视图”。
swagger-bootstrap-ui首页、文档和下载 - Swagger 前端 UI 实现 - 开源中国社区
Float_left Icon_close
全部项目分类
Apache
Java
跨平台
八一菜刀
分享
收藏
151 人收藏
收录时间:2017-04-19
swagger-bootstrap-ui 详细介绍

swagger-bootstrap-ui

简介

swagger-bootstrap-uiSwagger的前端UI实现,目的是替换Swagger默认的UI实现Swagger-UI,使文档更友好一点儿....

swagger-bootstrap-ui 只是Swagger的UI实现,并不是替换Swagger功能,所以后端模块依然是依赖Swagger的,需要配合Swagger的注解达到效果,注解说明

功能

  • 接口文档说明,效果图如下:

  • 在线调试功能,效果图如下:

Swagger简介

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

Swagger-UI默认效果图如下:

demo演示

swagger-bootstarp-ui-demo

下载

swagger-bootstrap-ui下载地址:下载

使用说明

  • 首先需要引入swagger的配置包信息,如下:
<!--swagger2-->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.2.2</version>
</dependency>
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.2.2</version>
</dependency>
  • maven项目中引用swagger-bootstrap-ui的jar包依赖,如下:
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.6</version>
</dependency>
  • Spring项目中启用swagger,代码如下:

1.注解方式

@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("developer@mail.com")

 .version("1.0")

 .build();

 }



}

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

注意事项

  • swagger封装给出的请求地址默认是/v2/api-docs,所以swagger-bootstrap-ui调用后台也是/v2/api-docs,不能带后缀,且需返回json格式数据,框架如果是spring boot的可以不用修改,直接使用,如果是Spring MVC在web.xml中配置了DispatcherServlet,则需要追加一个url匹配规则,如下:

 <servlet>

 <servlet-name>cmsMvc</servlet-name>

 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

 <init-param>

 <param-name>contextConfigLocation</param-name>

 <param-value>classpath:config/spring.xml</param-value>

 </init-param>

 <load-on-startup>1</load-on-startup>

</servlet>



<!--默认配置,.htm|.do|.json等等配置-->

<servlet-mapping>

 <servlet-name>cmsMvc</servlet-name>

 <url-pattern>*.htm</url-pattern>

</servlet-mapping>

<!-- 配置swagger-bootstrap-ui的url请求路径-->

<servlet-mapping>

 <servlet-name>cmsMvc</servlet-name>

 <url-pattern>/v2/api-docs</url-pattern>

</servlet-mapping>

鸣谢

特别感谢以下大牛开发的js/css、html前端框架,美观、易用

框架 网站
jquery http://jquery.com/
bootstrap http://getbootstrap.com
layer http://layer.layui.com/
jsonview https://github.com/yesmeck/jquery-jsonview
swagger-bootstrap-ui

选择将代码托管在码云
你还在等什么

可能是中国最大最好的代码托管平台


大家对 swagger-bootstrap-ui 的评论 (全部 15 条评论)
{{repayCom.userName}}
clowncrown
整体效果不错,但如果用swagger2的2.7.0版本,menu不会显示@Api的注释,而是以controller默认显示。另外好像不支持@ApiOperation中的tags分组。
遛羊的懒懒
在线调试时的响应内容没有响应码,建议加上。
伊超
不支持分组,强烈建议增加分组功能。
tl2327
同样出现swagger2的2.7.0版本,menu不会显示@Api的注释,而是以controller默认显示
Fatboy123
不错可用,换个皮肤玩玩
顶部