Skip to content

Swagger-Bootstrap-UI是Swagger的前端UI实现,可用来替换Swagger默认的UI,增加了诸多实用特性,提高工作开发效率。

Notifications You must be signed in to change notification settings

handosme/Swagger-Bootstrap-UI

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Swagger-Bootstrap-UI

简介

Swagger-Bootstrap-UISwagger的前端UI实现,可用来替换Swagger默认的UI,增加了诸多实用特性,提高工作开发效率。
Swagger-Bootstrap-UI 只是Swagger的UI实现,并不是替换Swagger功能,所以后端模块依然是依赖Swagger的,需要配合Swagger的注解达到效果。
Swagger-Bootstrap-UI提供如下特性:

  • 锚点定位到制定接口;
  • 关键字搜索接口;
  • 多层级返参类型缩进表格展示;
  • 自定义json参数名驼峰或下划线格式。

在线演示

api.ihansen.org

使用说明

1.首先需要引入swagger的配置包信息,如下:

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>${swagger.version}</version>
</dependency>

<!-- 这里swagger-ui是swagger的默认实现,这个jar可以不用引入,使用下面的swagger-bootstrap-ui替代-->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>${swagger.version}</version>
</dependency>

2.maven项目中引用swagger-bootstrap-ui的jar包依赖,如下:

<dependency>
   <groupId>org.ihansen.mbp</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.7</version>
</dependency>

3.其他配置和原Swagger保持一致即可。

参考使用swagger作为restful api的doc文档生成

界面效果

  • 接口文档说明,效果图如下:
  • 在线调试功能,效果图如下:

About

Swagger-Bootstrap-UI是Swagger的前端UI实现,可用来替换Swagger默认的UI,增加了诸多实用特性,提高工作开发效率。

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 76.4%
  • JavaScript 21.3%
  • HTML 2.3%