Swagger 前端 UI 实现 swagger-bootstrap-ui

Apache
Java
跨平台
2017-04-19
八一菜刀

swagger-bootstrap-ui

GitHub    Gitee    项目文档    项目demo    在线体验

简介

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

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

在线效果体验:http://swagger-bootstrap-ui.xiaominfo.com/doc.html

功能

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

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

Swagger简介

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

demo演示

swagger-bootstarp-ui-demo

下载

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

使用说明

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

 io.springfox
 springfox-swagger2
 2.2.2



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

  com.github.xiaoymin
  swagger-bootstrap-ui
  1.7.5
  • 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匹配规则,如下:

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



    cmsMvc
     *.htm



   cmsMvc
   /v2/api-docs

鸣谢

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

框架 网站
jquery http://jquery.com/
bootstrap http://getbootstrap.com
layer http://layer.layui.com/
jsonview https://github.com/yesmeck/jquery-jsonview
的码云指数为
超过 的项目
加载中

评论(18)

八一菜刀
八一菜刀 软件作者
😏最新最全面文档地址:http://www.xiaominfo.com/swagger-bootstrap-ui/
臣臣丶
臣臣丶

引用来自“八鼎网络”的评论

在本地可以用 http:/localhost:8080/doc.html打开,部署到服务器, 报404错误,提示没有doc.html,请问是什么原因?
应该是你的打包出问题了
八鼎网络
在本地可以用 http:/localhost:8080/doc.html打开,部署到服务器, 报404错误,提示没有doc.html,请问是什么原因?
遛羊的懒懒
遛羊的懒懒
在线调试时的响应内容没有响应码,建议加上。
伊超
不支持分组,强烈建议增加分组功能。
tl2327
tl2327
同样出现swagger2的2.7.0版本,menu不会显示@Api的注释,而是以controller默认显示
clowncrown
clowncrown
整体效果不错,但如果用swagger2的2.7.0版本,menu不会显示@Api的注释,而是以controller默认显示。另外好像不支持@ApiOperation中的tags分组。
Fatboy123
Fatboy123
不错可用,换个皮肤玩玩
Hei幕
Hei幕
.Net Core 2.0怎么配置啊,默认的皮肤以及在使用了,想用这个

Swagger-Bootstrap-Ui 1.8.9 发布,Swagger增强UI 实现

Swagger-Bootstrap-Ui 1.8.9 发布了。Swagger-Bootstrap-Ui是 Swagger 的增强UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 Swagger-Bootstrap-Ui 1.8.9 主要...

01/11 17:24

Swagger-Bootstrap-Ui 1.8.8 发布,Swagger 增强 UI 实现

Swagger-Bootstrap-Ui 1.8.8 发布了。Swagger-Bootstrap-Ui是 Swagger 的增强UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 Swagger-Bootstrap-Ui 1.8.8 主要...

2018/12/17 14:54

Swagger-Bootstrap-Ui 1.8.7 发布,Swagger增强UI 实现

Swagger-Bootstrap-Ui 1.8.7 发布了。Swagger-Bootstrap-Ui是 Swagger 的增强UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 从1.0到更新至今,Swagger-Bootst...

2018/11/12 08:57

Swagger-bootstrap-ui 1.8.6 发布,Swagger增强UI 实现

Swagger-bootstrap-ui 1.8.6 发布了。Swagger-bootstrap-ui 是 Swagger 的增强UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 Swagger-bootstrap-ui 1.8.6 主要...

2018/10/31 13:50

swagger-bootstrap-ui 1.8.5 发布,Swagger增强UI实现

swagger-bootstrap-ui 1.8.5 发布了。swagger-bootstrap-ui 是 Swagger 的增强UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 swagger-bootstrap-ui在1.8.5以后...

2018/10/16 09:09

swagger-bootstrap-ui 1.8.4 发布,Swagger 前端 UI 实现

swagger-bootstrap-ui 1.8.4 发布了。swagger-bootstrap-ui 是 Swagger 的前端 UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 swagger-bootstrap-ui 1.8.4 主...

2018/09/25 13:14

swagger-bootstrap-ui 1.8.3 发布,Swagger前端 UI 实现

swagger-bootstrap-ui 1.8.3 发布了。swagger-bootstrap-ui 是 Swagger 的前端 UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 swagger-bootstrap-ui 1.8.3 主...

2018/09/17 12:45

swagger-bootstrap-ui 1.8.2 发布,Swagger前端 UI 实现

swagger-bootstrap-ui 1.8.2 发布了。swagger-bootstrap-ui 是 Swagger 的前端 UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 swagger-bootstrap-ui 1.8.2 主...

2018/08/27 08:50

swagger-bootstrap-ui 1.8.1 发布,Swagger前端 UI 实现

swagger-bootstrap-ui 1.8.1 发布了。swagger-bootstrap-ui 是 Swagger 的前端 UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 swagger-bootstrap-ui 1.8.1 主...

2018/08/14 10:12

swagger-bootstrap-ui 1.8.0 发布,Swagger 前端 UI 实现

swagger-bootstrap-ui 1.8.0 发布了。swagger-bootstrap-ui 是 Swagger 的前端 UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 swagger-bootstrap-ui 1.8.0 主...

2018/08/10 11:32

没有更多内容

加载失败,请刷新页面

3
回答
swagger-bootstrap-ui 1.7.9 不支持上传文件

@八一菜刀 你好,想跟你请教个问题: 上边两张图是我做的一个上传文件的接口,一个是swagger-ui访问的,一个是swagger-bootstrap-u...

2018/08/20 14:17

没有更多内容

加载失败,请刷新页面

没有更多内容

springboot集成swagger

声明:仅作为初入java后端的开发人员做参考。大神勿喷。 现在流行前后端分离,以前我们测算api用postman来测试后台接口,每次都要输入接口地址,封装参数,挤麻烦又浪费时间。通过配置swagger...

2018/04/25 15:09
64
0
最近使用springfox(swagger)自动生成api文档时问题心得

package io.swagger.models.properties; import com.fasterxml.jackson.annotation.JsonGetter; import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annota...

2018/06/30 00:29
197
0
koa框架 mp2 node服务搭建swagger服务

说明:用koa2搭建静态文件服务器,mp2管理node服务,搭建swagger-ui和swagger-editor服务,项目地址:koa-swagger 1、环境搭建 安装最新版nodejs 新建文件夹koa-swagger,在文件夹内创建swa...

2018/07/04 11:59
507
0
Swagger Integration

This wiki writes down the integration between spring-boot and Swagger. Swagger is a powerful restful API framework. It can discover and generate documentation for rest API by us...

2016/04/26 15:35
30
1
Swagger上手教程

swagger零基础教程

2016/07/23 21:08
945
0
tp5 集成swagger

大家都是比较推荐的APP写API接口文档Swagger ui这个框架,现在就记录一下环境的搭建。 Swagger ui 也是基于html+javascript实现的,而且可以实现在线测试的功能,方便开发人员和测试人员进行...

2018/04/16 17:44
150
0
Lumen微服务生成Swagger文档

[TOC] 作为一名phper,在使用Lumen框架开发微服务的时候,API文档的书写总是少不了的,比较流行的方式是使用swagger来写API文档,但是与Java语言原生支持 annotation 不同,php只能单独维护一...

01/02 16:15
17
0
springmvc轻松整合springfox

springfox介绍 Springfox的前身是swagger-springmvc,是一个开源的API doc框架,可以将我们的Controller的方法以文档的形式展现。 1.引入springfox依赖jar包 <!-- springfox -->...

2016/12/27 08:55
193
0
Swagger环境搭建之非依赖代码法

前言 Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集...

2016/10/15 20:06
1K
0
Spring MVC 整合 Swagger

Swagger 简要说明 将Swagger和Swagger UI集成到系统中,可以实现接口可视化界面操作。 版本号 Swagger UI 2.2.10 高于该版本,可能会出现“No operations defined in spec”错误 下载地址:h...

2018/04/24 17:56
73
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部