swagger-bootstrap-ui

目前，大多数公司都采用了前后端分离的开发模式，为了解决前后端人员的沟通问题，后端人员在开发接口的时候会选择使用swagger2来生成对应的接口文档，swagger2提供了强大的页面调试功能，这样可以有效解决前后端人员沟通难的问题。 下面我们使用SpringBoot结合swagger2生成Restful API文档。 一 搭建项目，引入依赖 新建一个 spring-boot-swaager 的项目，引入swaager2的依赖，由于swagger2的ui不是很美观，这里将使用开源的 swagger-bootstrap-ui 做为ui。 引入依赖 <!-- swaager2依赖 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- swaager2ui --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.9.6</version> </dependency> 项目中配置swagger相关信息

需求背景 spring cloud搭建微服务系统，每个业务模块使用swagger开放文档接口查询，在业务网关模块提供swagger文档聚合查询接口，可以通过选择业务模块分类查看。 框架选型、版本及主要功能 spring boot 2.1.6.RELEASE spring cloud Greenwich.SR3 spring cloud gateway 2.1.3.RELEASE 网关组件 knife4j 2.0.1 增强swagger ui样式，网关使用其starter依赖 swagger bootstrap ui 1.9.6 增强swagger ui样式 spring4all-swagger 1.9.0.RELEASE 配置化swagger参数，免去代码开发 模块职责划分 swagger组件 开发一个项目内的swagger-spring-boot-starter，整合swagger bootstrap ui 1.9.6和spring4all-swagger 1.9.0.RELEASE，对外提供@EnableSwagger注解服务 业务模块 引用自定义的swagger-spring-boot-starter，同时在配置文件中添加本模块的swagger基础信息配置。 网关模块 引用knife4j整合swagger，并开发filter、handler

官网说明及用法： 简介 swagger-bootstrap-ui 是springfox-swagger的增强UI实现，为Java开发者在使用Swagger的时候，能拥有一份简洁、强大的接口文档体验 核心功能 该UI增强包主要包括两大核心功能：文档说明 和 在线调试 文档说明：根据Swagger的规范说明，详细列出接口文档的说明，包括接口地址、类型、请求示例、请求参数、响应示例、响应参数、响应码等信息，使用swagger-bootstrap-ui能根据该文档说明，对该接口的使用情况一目了然。 在线调试：提供在线接口联调的强大功能，自动解析当前接口参数,同时包含表单验证，调用参数可返回接口响应内容、headers、Curl请求命令实例、响应时间、响应状态码等信息，帮助开发者在线调试，而不必通过其他测试工具测试接口是否正确,简介、强大。 UI增强 同时，swagger-bootstrap-ui在满足以上功能的同时，还提供了文档的增强功能，这些功能是官方swagger-ui所没有的，每一个增强的功能都是贴合实际,考虑到开发者的实际开发需要,是比不可少的功能，主要包括： 个性化配置：通过个性化ui配置项，可自定义UI的相关显示信息 离线文档：根据标准规范，生成的在线markdown离线文档，开发者可以进行拷贝生成markdown接口文档

介绍 knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍! knife4j的前身是swagger-bootstrap-ui，为了契合微服务的架构发展,由于原来swagger-bootstrap-ui采用的是后端Java代码+前端Ui混合打包的方式,在微服务架构下显的很臃肿,因此项目正式更名为knife4j。 目前项目主要的模块如下： 此示例根据官方文档介绍演示。 开源仓库 Github https://github.com/xiaoymin/swagger-bootstrap-ui 码云 https://gitee.com/xiaoym/knife4j 核心功能 该UI增强包主要包括两大核心功能：文档说明 和 在线调试 文档说明：根据Swagger的规范说明，详细列出接口文档的说明，包括接口地址、类型、请求示例、请求参数、响应示例、响应参数、响应码等信息，使用swagger-bootstrap-ui能根据该文档说明，对该接口的使用情况一目了然。 在线调试：提供在线接口联调的强大功能，自动解析当前接口参数,同时包含表单验证，调用参数可返回接口响应内容、headers、Curl请求命令实例、响应时间、响应状态码等信息，帮助开发者在线调试

近期研究学习Spring Boot 2.0及MongoDB期间，尝试用Reactive模式实现了一个简单的文件共享服务器，可用于家庭及小型组织内部的文件共享，目前已实现如下功能： 1. 管理员及普通账号鉴权； 2. 分组文件管理，分目录管理； 3. 文件批量下载，PDF及图片格式文件预览与下载； 4. 目录管理与账号管理； 5. 各个基础功能的REST API接口； 6. 新增TensorFlow 自动识别图像内容，为图像增加内容标签 开发环境配置如下： JDK最低版本要求 Java SE 1.8, 目前在JDK9.0版本环境还存在一些兼容性问题。 Spring Framework 5.0.3.RELEASE + Spring Boot 2.0.BUILD-SNAPSHOT Spring Security 5.0.1.RELEASE Kotlin 1.2 (目前仅用于建立实体映射Bean) Springfox Swagger 2.8.0 + swagger-bootstrap-ui 1.7.2 （不同的REST API展示界面） MongoDB 3.6.2 （配置数据及文件存储） 后端文件全部存储在MongoDB库内， 本示例程序启动操作简单，具体操作步骤如下： 1. 从码云下载代码库，在本地通过gradle命令编译生成jar包； 2. 下载MongoDB，启动mongodb实例；

编者注 之前让其他写服务端的小伙伴支持swagger，然后最近一直在写Unity，没有把之前的项目和Swagger进行集成 Swagger Core Swagger Core Git Swagger 2.X 快速开始 注意：Swagger 2.x 遵循 OpenApi 3.0 定义的文件。如果你期望使用1.5.x版本的Swagger或者OpenApi 2.0，请参考 1.5.X JAX-RS Setup SpringBoot与Swagger2 Gradle dependencies { // 原生UI //compile("io.springfox:springfox-swagger-ui:2.9.2") // 国内人编写的左右分隔的UI compile("com.github.xiaoymin:swagger-bootstrap-ui:1.8.9") compile("io.springfox:springfox-swagger2:2.9.2") //... } 配置 由于springboot需要手动编写配置Bean，则代码如下 @Configuration @EnableSwagger2 public class SwaggerConfiguration { @Bean public Docket createRestApi(){ return new Docket