swagger-bootstrap-ui

Swagger-Bootstrap-UI is the front of the UI Swagger implementation, using jQuery+bootstrap implementation, the purpose is to replace the default UI Swagger implementation of the Swagger-UI, so that the document is more friendly...

License

License

Categories

Categories

Swagger Program Interface REST Frameworks
GroupId

GroupId

org.ihansen.mbp
ArtifactId

ArtifactId

swagger-bootstrap-ui
Last Version

Last Version

1.7.1
Release Date

Release Date

Type

Type

jar
Description

Description

swagger-bootstrap-ui
Swagger-Bootstrap-UI is the front of the UI Swagger implementation, using jQuery+bootstrap implementation, the purpose is to replace the default UI Swagger implementation of the Swagger-UI, so that the document is more friendly...
Project URL

Project URL

https://github.com/handosme/Swagger-Bootstrap-UI
Source Code Management

Source Code Management

https://github.com/handosme/Swagger-Bootstrap-UI.git

Download swagger-bootstrap-ui

How to add to project

<!-- https://jarcasting.com/artifacts/org.ihansen.mbp/swagger-bootstrap-ui/ -->
<dependency>
    <groupId>org.ihansen.mbp</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.7.1</version>
</dependency>
// https://jarcasting.com/artifacts/org.ihansen.mbp/swagger-bootstrap-ui/
implementation 'org.ihansen.mbp:swagger-bootstrap-ui:1.7.1'
// https://jarcasting.com/artifacts/org.ihansen.mbp/swagger-bootstrap-ui/
implementation ("org.ihansen.mbp:swagger-bootstrap-ui:1.7.1")
'org.ihansen.mbp:swagger-bootstrap-ui:jar:1.7.1'
<dependency org="org.ihansen.mbp" name="swagger-bootstrap-ui" rev="1.7.1">
  <artifact name="swagger-bootstrap-ui" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.ihansen.mbp', module='swagger-bootstrap-ui', version='1.7.1')
)
libraryDependencies += "org.ihansen.mbp" % "swagger-bootstrap-ui" % "1.7.1"
[org.ihansen.mbp/swagger-bootstrap-ui "1.7.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

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文档生成

界面效果

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

Versions

Version
1.7.1
1.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1