Swagger2生成支付文档

.gitignore

@@ -6,7 +6,7 @@
 *.war
 *.ear
 /target/
-
+/log/
 /.settings/
 *.project
 *.classpath

src/main/java/com/itstyle/modules/alipay/controller/AliPayController.java

@@ -1,5 +1,8 @@
 package com.itstyle.modules.alipay.controller;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+
 import java.io.BufferedOutputStream;
 import java.util.Enumeration;
 import java.util.HashMap;
@@ -23,36 +26,41 @@ import com.itstyle.common.constants.Constants;
 import com.itstyle.common.model.Product;
 import com.itstyle.modules.alipay.service.IAliPayService;
 /**
- * 支付宝二维码支付
+ * 支付宝支付
  * 创建者 科帮网
  * 创建时间	2017年7月30日
  */
+@Api(tags ="支付宝支付")
 @Controller
 @RequestMapping(value = "alipay")
 public class AliPayController {
 	private static final Logger logger = LoggerFactory.getLogger(AliPayController.class);
 	@Autowired
 	private IAliPayService aliPayService;
-
-	@RequestMapping("/index")
+	
+	@ApiOperation(value="支付主页")
+	@RequestMapping(value="index",method=RequestMethod.GET)
     public String   index() {
         return "alipay/index";
     }
-	@RequestMapping("/pcPay")
+	@ApiOperation(value="电脑支付")
+	@RequestMapping(value="pcPay",method=RequestMethod.POST)
     public String  pcPay(Product product,ModelMap map) {
 		logger.info("电脑支付");
 		String form  =  aliPayService.aliPayPc(product);
 		map.addAttribute("form", form);
 		return "alipay/pay";
     }
-	@RequestMapping("/mobilePay")
+	@ApiOperation(value="手机H5支付")
+	@RequestMapping(value="mobilePay",method=RequestMethod.POST)
     public String  mobilePay(Product product,ModelMap map) {
 		logger.info("手机H5支付");
 		String form  =  aliPayService.aliPayMobile(product);
 		map.addAttribute("form", form);
 		return "alipay/pay";
     }
-	@RequestMapping("/qcPay")
+	@ApiOperation(value="二维码支付")
+	@RequestMapping(value="qcPay",method=RequestMethod.POST)
     public String  qcPay(Product product,ModelMap map) {
 		logger.info("二维码支付");
 		String message  =  aliPayService.aliPay(product);
@@ -73,9 +81,9 @@ public class AliPayController {
      * @Date	2017年7月30日
      * 更新日志
      * 2017年7月30日  科帮网 首次创建
-     *
      */
-	@RequestMapping(value = "pay",method = RequestMethod.POST)
+	@ApiOperation(value="支付宝支付回调(二维码、H5、网站)")
+	@RequestMapping(value="pay",method=RequestMethod.POST)
 	public void alipay_notify(HttpServletRequest request, HttpServletResponse response) throws Exception {
 		String  message = "success";
 		Map<String, String> params = new HashMap<String, String>();

src/main/java/com/itstyle/modules/unionpay/controller/UnionPayController.java

@@ -1,5 +1,8 @@
 package com.itstyle.modules.unionpay.controller;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+
 import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.Iterator;
@@ -15,6 +18,7 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Controller;
 import org.springframework.ui.ModelMap;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
 
 import com.itstyle.common.constants.PayWay;
 import com.itstyle.common.model.Product;
@@ -26,8 +30,8 @@ import com.itstyle.modules.unionpay.util.SDKConstants;
  * 银联支付
  * 创建者 科帮网
  * 创建时间	2017年8月2日
- *
  */
+@Api(tags ="银联支付")
 @Controller
 @RequestMapping(value = "unionpay")
 public class UnionPayController {
@@ -36,12 +40,14 @@ public class UnionPayController {
 	@Autowired
 	private IUnionPayService unionPayService;
 
-	@RequestMapping("/index")
+
+	@ApiOperation(value="银联支付主页")
+	@RequestMapping(value="index",method=RequestMethod.GET)
     public String   index() {
         return "unionpay/index";
     }
-	
-	@RequestMapping("/pcPay")
+	@ApiOperation(value="电脑支付")
+	@RequestMapping(value="pcPay",method=RequestMethod.POST)
     public String  pcPay(Product product,ModelMap map) {
 		logger.info("电脑支付");
 		product.setPayWay(PayWay.PC.getCode());
@@ -49,7 +55,8 @@ public class UnionPayController {
 		map.addAttribute("form", form);
 		return "unionpay/pay";
     }
-	@RequestMapping("/mobilePay")
+	@ApiOperation(value="手机H5支付")
+	@RequestMapping(value="mobilePay",method=RequestMethod.POST)
     public String  mobilePay(Product product,ModelMap map) {
 		logger.info("手机H5支付");
 		product.setPayWay(PayWay.MOBILE.getCode());
@@ -72,7 +79,8 @@ public class UnionPayController {
 	 * 2017年8月2日  科帮网 首次创建
 	 *
 	 */
-	@RequestMapping(value = "pay")
+	@ApiOperation(value="银联回调通知")
+	@RequestMapping(value="pay",method=RequestMethod.POST)
 	public void union_notify(HttpServletRequest request, HttpServletResponse response) throws Exception {
         logger.info("银联接收后台通知开始");
 		String encoding = request.getParameter(SDKConstants.param_encoding);

src/main/java/com/itstyle/modules/weixinpay/controller/WeixinMobilePayController.java

@@ -1,5 +1,8 @@
 package com.itstyle.modules.weixinpay.controller;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+
 import java.io.BufferedOutputStream;
 import java.util.Map;
 import java.util.SortedMap;
@@ -16,6 +19,7 @@ import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Controller;
 import org.springframework.ui.ModelMap;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
 
 import com.itstyle.common.model.Product;
 import com.itstyle.common.utils.AddressUtils;
@@ -27,11 +31,12 @@ import com.itstyle.modules.weixinpay.util.PayCommonUtil;
 import com.itstyle.modules.weixinpay.util.XMLUtil;
 import com.itstyle.modules.weixinpay.util.mobile.MobileUtil;
 /**
- * 微信公众号H5支付
+ * 微信H5支付
  * 创建者 科帮网
  * 创建时间	2017年7月31日
  *
  */
+@Api(tags ="微信H5支付")
 @Controller
 @RequestMapping(value = "weixinMobile")
 public class WeixinMobilePayController {
@@ -41,18 +46,20 @@ public class WeixinMobilePayController {
 	@Value("${server.context.url}")
 	private String server_url;
 	
-	@RequestMapping("/pay")
+	@ApiOperation(value="H5支付(需要公众号内支付)")
+	@RequestMapping(value="pay",method=RequestMethod.POST)
     public String  pay(Product product,ModelMap map) {
 		logger.info("H5支付(需要公众号内支付)");
 		String url =  weixinPayService.weixinPayMobile(product);
 		return "redirect:"+url;
     }
-	//公众号H5支付主页
-	@RequestMapping(value = "payPage")
+	@ApiOperation(value="公众号H5支付主页")
+	@RequestMapping(value="payPage",method=RequestMethod.GET)
 	public String pay(HttpServletRequest request, HttpServletResponse response) throws Exception {
 		return "weixin/payPage";
 	}
-	@RequestMapping("/h5pay")
+	@ApiOperation(value="纯H5支付(不建议在APP端使用)")
+	@RequestMapping(value="h5pay",method=RequestMethod.POST)
     public String  h5pay(Product product,ModelMap map) {
 		logger.info("纯H5支付(不建议在APP端使用)");
 		//mweb_url为拉起微信支付收银台的中间页面，可通过访问该url来拉起微信客户端，完成支付,mweb_url的有效期为5分钟。
@@ -63,7 +70,8 @@ public class WeixinMobilePayController {
 			return "redirect:https://blog.52itstyle.com";//自定义错误页面
 		}
     }
-	@RequestMapping("/smallRoutine")
+	@ApiOperation(value="小程序支付(需要HTTPS)")
+	@RequestMapping(value="smallRoutine",method=RequestMethod.POST)
     public String  smallRoutine(Product product,ModelMap map) {
 		logger.info("小程序支付(需要HTTPS)、不需要支付目录和授权域名");
 		String url =  weixinPayService.weixinPayMobile(product);
@@ -82,7 +90,8 @@ public class WeixinMobilePayController {
 	 *
 	 */
 	@SuppressWarnings("rawtypes")
-	@RequestMapping(value = "dopay")
+	@ApiOperation(value="预下单")
+	@RequestMapping(value="dopay",method=RequestMethod.POST)
 	public String dopay(HttpServletRequest request, HttpServletResponse response) throws Exception {
 		String orderNo = request.getParameter("outTradeNo");
 		String totalFee = request.getParameter("totalFee");
@@ -153,7 +162,8 @@ public class WeixinMobilePayController {
 	 * 2017年7月31日  科帮网 首次创建
 	 *
 	 */
-	@RequestMapping(value = "WXPayBack")
+	@ApiOperation(value="手机支付完成回调")
+	@RequestMapping(value="WXPayBack",method=RequestMethod.POST)
 	public void WXPayBack(HttpServletRequest request, HttpServletResponse response){
 		String resXml = "";
 		try {

src/main/java/com/itstyle/modules/weixinpay/controller/WeixinPayController.java

@@ -1,4 +1,7 @@
 package com.itstyle.modules.weixinpay.controller;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+
 import java.io.BufferedOutputStream;
 import java.io.BufferedReader;
 import java.io.InputStream;
@@ -19,6 +22,7 @@ import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Controller;
 import org.springframework.ui.ModelMap;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
 
 import com.itstyle.common.constants.Constants;
 import com.itstyle.common.model.Product;
@@ -29,10 +33,11 @@ import com.itstyle.modules.weixinpay.util.PayCommonUtil;
 import com.itstyle.modules.weixinpay.util.XMLUtil;
 
 /**
- * 微信二维码支付
+ * 微信支付
  * 创建者 科帮网
  * 创建时间	2017年7月31日
  */
+@Api(tags ="微信支付")
 @Controller
 @RequestMapping(value = "weixin")
 public class WeixinPayController {
@@ -43,11 +48,13 @@ public class WeixinPayController {
 	@Value("${wexinpay.notify.url}")
 	private String notify_url;
 	
-	@RequestMapping("/index")
+	@ApiOperation(value="支付主页")
+	@RequestMapping(value="index",method=RequestMethod.GET)
     public String   index() {
         return "weixinpay/index";
     }
-	@RequestMapping("/qcPay")
+	@ApiOperation(value="二维码支付")
+	@RequestMapping(value="qcPay",method=RequestMethod.POST)
     public String  qcPay(Product product,ModelMap map) {
 		logger.info("二维码支付");
 		//参数自定义  这只是个Demo
@@ -75,7 +82,8 @@ public class WeixinPayController {
 	 *
 	 */
 	@SuppressWarnings({ "unchecked", "rawtypes" })
-	@RequestMapping(value = "pay")
+	@ApiOperation(value="支付后台回调")
+	@RequestMapping(value="pay",method=RequestMethod.POST)
 	public void weixin_notify(HttpServletRequest request, HttpServletResponse response) throws Exception {
 		// 读取参数
 		InputStream inputStream = request.getInputStream();
@@ -150,7 +158,8 @@ public class WeixinPayController {
 	 *
 	 */
 	@SuppressWarnings({ "unchecked", "rawtypes"})
-	@RequestMapping(value = "bizpayurl")
+	@ApiOperation(value="模式一支付回调URL")
+	@RequestMapping(value="bizpayurl",method=RequestMethod.POST)
 	public void bizpayurl(HttpServletRequest request, HttpServletResponse response) throws Exception {
 		logger.info("模式一支付回调URL");
 		//读取参数