swagger

@ApiImplicitParam： 作用在方法上，表示单独的请求参数 参数： 1. name ：参数名。 2. value ： 参数的具体意义，作用。 3. required ： 参数是否必填。 4. dataType ：参数的数据类型。 5. paramType ：查询参数类型，这里有几种形式： 类型 作用 path 以地址的形式提交数据 query 直接跟参数完成自动映射赋值 body 以流的形式提交 仅支持POST header 参数在request headers 里边提交 form 以form表单的形式提交 仅支持POST 在这里我被坑过一次：当我发POST请求的时候，当时接受的整个参数，不论我用body还是query，后台都会报Body Missing错误。这个参数和SpringMvc中的@RequestBody冲突，索性我就去掉了paramType，对接口测试并没有影响。 @ApiImplicitParams： 用于方法，包含多个 @ApiImplicitParam： 例： @ApiOperation("查询测试") @GetMapping("select") //@ApiImplicitParam(name="name",value="用户名",dataType="String", paramType = "query") @ApiImplicitParams({

GitHub 地址： https://github.com/JMCuixy/swagger2word 原创作品，转载请注明出处： http://www.cnblogs.com/jmcui/p/8298823.html 一、前言 为什么会产生这个需求呢？ 我们公司作为乙方，老是被客户追着要一份API文档，当我们把一个 Swagger 文档地址丢给客户的时候。客户还是很不满意，嫌不够正式！！死活坚持要一份 word 文档 。然后领导给了个接口模板，就把这个活交给我了......我去，近10个微服务，几百个接口，这不得要了我的命啊（最后整理出来将近200页的 word 文档）。最后，还是领导有办法：要不我们把Swagger的 json文件转成word文档吧！ 一直坚持一句话。作为使用者，人要迁就机器；作为开发者，要机器迁就人。 二、思路 领导提供了一个接口模板，类似下面这样，其实就是一个word的table页。想到 html 可以转 word ，那么问题就变成了 ： 1、解析JSON 文件 2、把JSON文件的内容填充进html 的Table中 3、由html直接转成word 几百个接口，一气呵成！如下，还有一个简单的示例，就是请求参数 和 返回值 。怎么处理呢？在程序中写了 HTTP 的请求，封装了需要的参数去执行了一个请求，得到相应的返回值！ 三、实现 1、封装对象

前言 最近看到很多童鞋在项目中的对请求参数的校验都用的if来判断各参数的属性，如： if (StringUtils.isBlank(username)){ return RR.exception("账号不能为空" ); } if (StringUtils.isBlank(password)){ return RR.exception("密码不能为空" ); } if (StringUtils.isBlank(realName)){ return RR.exception("姓名不能为空" ); } ...... 每个参数都需要这样一个个去校验null,返回对应信息，代码就像叠罗汉一样~~，在此，楼主强烈推荐一个神器:Validation，有了它，再也不用这样去校验参数啦，可以让我们在项目中不用太关注其他东西，专注于业务逻辑的编写。 引入核心依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> 使用示例-添加用户 需要校验的实体类，在此使用了一些常用的校验注解，基本上能够见名知意，每个注解中都有message属性，就是校验不通过后的提示信息 @Data @AllArgsConstructor

背景 好像是上周四，看到微信群有人说java有轮子swagger-bootstrap-ui，而c#，就是找不到。 于是我一看，就说大话：“这个只是一套UI，他这个有开源地址么” 被@at说:你试试... 当天晚上就把swagger-ui, Knife4j,Swashbuckle.AspNetCore项目的源码都下载下来研究下，看看能不能集成到AspNETCore下，这样我们就能给Swagger UI换套新皮肤。 knife4j knife4j 是swagger-bootstrap-ui库的升级版，作者已全面升级，全部以knife4j命名。 Gitee上也有2.8K 效果图 IGeekFan.AspNetCore.Knife4jUI 他是swagger ui 库： knife4j UI 的.NET Core封装，支持 .NET Core3.0+或.NET Standard2.0。 https://github.com/luoyunchong/IGeekFan.AspNetCore.Knife4jUI 概念对应关系如下 功能 c# java 实现swagger规范 Swashbuckle.AspNetCore spring-fox 封装成nuget包/maven包的UI库 Swashbuckle.AspNetCore.SwaggerUI knife4j-v3-spring-ui UI库

背景 好像是上周四，看到微信群有人说java有轮子swagger-bootstrap-ui，而c#，就是找不到。 于是我一看，就说大话：“这个只是一套UI，他这个有开源地址么” 被@at说:你试试... 当天晚上就把swagger-ui, Knife4j,Swashbuckle.AspNetCore项目的源码都下载下来研究下，看看能不能集成到AspNETCore下，这样我们就能给Swagger UI换套新皮肤。 knife4j knife4j 是swagger-bootstrap-ui库的升级版，作者已全面升级，全部以knife4j命名。 Gitee上也有2.8K 效果图 IGeekFan.AspNetCore.Knife4jUI 他是swagger ui 库： knife4j UI 的.NET Core封装，支持 .NET Core3.0+或.NET Standard2.0。 https://github.com/luoyunchong/IGeekFan.AspNetCore.Knife4jUI 概念对应关系如下 功能 c# java 实现swagger规范 Swashbuckle.AspNetCore spring-fox 封装成nuget包/maven包的UI库 Swashbuckle.AspNetCore.SwaggerUI knife4j-v3-spring-ui UI库

背景 好像是上周四，看到微信群有人说java有轮子swagger-bootstrap-ui，而c#，就是找不到。 于是我一看，就说大话：“这个只是一套UI，他这个有开源地址么” 被@at说:你试试... 当天晚上就把swagger-ui, Knife4j,Swashbuckle.AspNetCore项目的源码都下载下来研究下，看看能不能集成到AspNETCore下，这样我们就能给Swagger UI换套新皮肤。 knife4j knife4j 是swagger-bootstrap-ui库的升级版，作者已全面升级，全部以knife4j命名。 Gitee上也有2.8K 效果图 IGeekFan.AspNetCore.Knife4jUI 他是swagger ui 库： knife4j UI 的.NET Core封装，支持 .NET Core3.0+或.NET Standard2.0。 https://github.com/luoyunchong/IGeekFan.AspNetCore.Knife4jUI 概念对应关系如下 功能 c# java 实现swagger规范 Swashbuckle.AspNetCore spring-fox 封装成nuget包/maven包的UI库 Swashbuckle.AspNetCore.SwaggerUI knife4j-v3-spring-ui UI库

Spring Boot集成Swagger 目录 Spring Boot集成Swagger 前言 基本概述 案例 引入依赖 Swagger配置 配置方式 基本概述 控制器 统一响应类 用户Model 文档界面 源码 参考信息 前言 为了完成项目自带文档的需求，花了一定的时间研究 Spring Boot 集成 Swagger 。看了官方文档和一些博客，差不多搭出一个比较通用的架子。 文末会分享出案例项目。 基本概述 本文使用 Spring Boot + Spring Fox 的方式集成 Swagger 框架。 案例 引入依赖 <properties> <swagger.version>2.7.0</swagger.version> </properties> <dependencies> <!-- swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>${swagger.version}</version> </dependency> <!-- swagger2 ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox

项目简介 星然云商城是基于当前流行技术采用前后端分离商城系统,包含商城,会员,充值,购物车,退款,订单,付款等功能，更适合企业,个人二次开发； 项目开源地址： https://github.com/xrshop/xrshop_h5 项目官网地址： http://ds.judaixia.com 主要功能如下： ① 订单模块：下单、购物车、支付，发货、收货、评价、退款等 ② 配置模块：各种配置 ③ 用户模块：登陆、注册、会员卡、充值、购买等 ④ 商品模块：商品添加、规格设置，商品上下架等 ⑤ 其他等 部分功能截图如下: 技术选型: 后端使用技术 1.1 SpringBoot2 1.2 MyBatis-Plus 1.3 SpringSecurity 1.4 Redis 1.5 Quartz 1.6 Mysql 1.7 swagger 1.8 Lombok 1.9 Hutool 1.10 Mapstruct 1.11 Redisson 前端使用技术 2.1 TypeScript3 2.2 Vue2 2.2 Sass 2.2 VueCli3 2.2 WebPack4 2.2 Babel 2.2 Git 2.2 Nginx​ 来源： oschina 链接： https://my.oschina.net/u/4552122/blog/4464157

集成.NET Core+Swagger+Consul+Polly+Ocelot+IdentityServer4+Exceptionless+Apollo的微服务开发框架 Github源代码地址 https://github.com/PeyShine/Demo.MicroServer Apollo配置中心 Apollo（阿波罗）是携程框架部门研发的分布式配置中心，能够集中化管理应用不同环境、不同集群的配置，配置修改后能够实时推送到应用端，并且具备规范的权限、流程治理等特性，适用于微服务配置管理场景。 由于各个项目配置都需要读取基础的配置信息，这边在内网的Centos(101)上部署了Apollo的环境，并为项目添加了一些基础配置信息，配置如图 Consul Consul是一种服务网格解决方案，提供具有服务发现，健康检查，Key/Value存储，多数据中心等功能。 在内网101启动Consul服务，这里为了测试，直接在本地将用户服务实例分别在三个端口启动起来，实际生产中这些服务可能部署在不同的机房不同的机器，他们之间组成一个服务的集群，服务提供一个心跳检测的方法，用于consul定时检测服务实例是否健康，启动时在consul中进行一次注册，这个就是经常说的‘服务注册与发现’中的服务注册，三个服务实例截图如下 注册完成之后打开consul的ui界面可以看到

（1） 相关博文地址： SpringBoot + Vue + ElementUI 实现后台管理系统模板 -- 前端篇（一）：搭建基本环境：https: // www.cnblogs.com/l-y-h/p/12930895.html SpringBoot + Vue + ElementUI 实现后台管理系统模板 -- 前端篇（二）：引入 element-ui 定义基本页面显示：https: // www.cnblogs.com/l-y-h/p/12935300.html SpringBoot + Vue + ElementUI 实现后台管理系统模板 -- 前端篇（三）：引入 js-cookie、axios、mock 封装请求处理以及返回结果：https: // www.cnblogs.com/l-y-h/p/12955001.html SpringBoot + Vue + ElementUI 实现后台管理系统模板 -- 前端篇（四）：引入 vuex 进行状态管理、引入 vue-i18n 进行国际化管理：https: // www.cnblogs.com/l-y-h/p/12963576.html SpringBoot + Vue + ElementUI 实现后台管理系统模板 -- 前端篇（五）：引入 vue-router 进行路由管理、模块化封装 axios 请求、使用