easy-swagger

Easy-swagger

介绍

当你出于不想写文档的目的使用swagger的时候，有没有觉得，其实，工作量一点都没少？该写的一点没少，之前是写文档，现在是写一堆注解，是不是心里一万句草泥马策马奔腾。现在，easy-swagger来了，简化你的sawgger使用体验，从此，踏上人生巅峰！github项目地址：https://github.com/xiaoyudeguang/easy-swagger

使用说明

Maven引用(点击 最新版本地址 查看最新版本)

<dependency>
    <groupId>io.github.xiaoyudeguang</groupId>
    <artifactId>easy-swagger</artifactId>
    <version>3.1.8-RELREASE</version>
</dependency>

使用案例

@SpringController( value= "demoController", todo = { "easy-swagger使用示例" })
public class DemoController{

	@SpringMapping( value= "test", todo = { "easy-swagger示例方法" }, notes ="随便写点啥，当做方法简介吧")
	public Object test(String name, String age) {
		Console.log( name, age);
		return "easy-swagger is an good tool!";
	}
}

PS：easy-swagger已经替你完成了swagger的配置，请不要再配置一遍了。你只需要把你喜欢的插件引入你的项目，访问插件提供的访问地址即可。理论上，easy-swagger可以兼容任何一款已有的swagger插件，并优化它。

官方界面和三方插件界面查看路径(easy-swagger本身不提供管理界面)

如果你啥插件都没引入，浏览器直接访问：http://localhost:8080/swagger-ui.html

另外推介几款插件：

1. swagger-mg-ui（浏览器直接访问：http://localhost:8080/document.html） ---->墙裂推介

<dependency>
    <groupId>com.zyplayer</groupId>
    <artifactId>swagger-mg-ui</artifactId>
    <version>1.0.6</version>
</dependency>

1. swagger-bootstrap-ui（浏览器直接访问：http://localhost:8080/doc.html） ----> 挺好的，就是颜色单调(蓝色)

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.8.8</version>
</dependency>

接口权限

为了感谢广大朋友们的支持，easy-swagger开业大酬宾啦！只需对代码做如下的改造：

@SpringController( value= "demoController", todo = { "easy-swagger使用示例" })
public class DemoController{

	@SpringMapping( value= "test", todo = { "easy-swagger示例方法" }, notes ="随便写点啥，当做方法简介吧", level=4)
	public Object test(String name, String age) {
		Console.log( name, age);
		return "easy-swagger is an good tool!";
	}
}

然后在application.properties里增加下面的属性，再次打开swagger界面就找不到test方法喽。

easy.swagger.level=5

解释下原理：easy-swagger默认在SpringMapping注解中将所有的接口定义为level=5，每次只展示接口level值大于等于application.properties里level属性值的接口。SpringMapping部分源码如下：

/**
 * 显示级别(在swagger中只显示大于application.peoperties文件中配置的level的接口)
 * @return
 */
int level() default 5;