修改

YijiaRestful/pom.xml

@@ -21,6 +21,42 @@
 
     <dependencies>
 
+        <!--swagger图形化接口-->
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>2.9.2</version>
+            <!--忽略原版本的swagger-annotations和swagger-models，添加1.5.21版本的-->
+            <exclusions>
+                <exclusion>
+                    <groupId>io.swagger</groupId>
+                    <artifactId>swagger-annotations</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>io.swagger</groupId>
+                    <artifactId>swagger-models</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+        <!--解决进入swagger页面报类型转换错误，排除2.9.2中的引用，手动增加1.5.21版本-->
+        <dependency>
+            <groupId>io.swagger</groupId>
+            <artifactId>swagger-annotations</artifactId>
+            <version>1.5.21</version>
+        </dependency>
+        <dependency>
+            <groupId>io.swagger</groupId>
+            <artifactId>swagger-models</artifactId>
+            <version>1.5.21</version>
+        </dependency>
+
+        <!--swagger 可视化界面UI-->
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>2.9.2</version>
+        </dependency>
+
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-annotations</artifactId>

YijiaRestful/src/main/java/com/platform/yijia/controller/IntegralShoppingMallController.java

@@ -12,6 +12,10 @@ import com.platform.yijia.utils.ResultData;
 import com.platform.yijia.utils.redis.RedisCacheUtil;
 import com.platform.yijia.utils.weixinapp.WeiXinUserUtil;
 import com.platform.yijia.utils.weixinapp.WxPushUtil;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import me.chanjar.weixin.mp.bean.template.WxMpTemplateData;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
@@ -34,6 +38,7 @@ import java.util.*;
 @Controller
 @YiJiaRequest()
 @CrossOrigin
+@Api(tags = "积分商城")
 public class IntegralShoppingMallController {
     private static Logger logger =(Logger) LoggerFactory.getLogger(IntegralShoppingMallController.class);
     @Resource
@@ -60,7 +65,8 @@ public class IntegralShoppingMallController {
     //获取积分商城轮播图片
     @RequestMapping(value = "/getIntegralShopPicInfoList", method = RequestMethod.GET)
     @ResponseBody
-    public String getIntegralShopPicInfoList(@RequestParam Integer stationId){
+    @ApiOperation(value = "获取积分商城轮播图片", httpMethod = "GET", notes = "积分商城轮播图片")
+    public String getIntegralShopPicInfoList(@ApiParam(value = "油站ID", required = true) @RequestParam Integer stationId){
         Gson gson =new Gson();
         //返回结果集
         ResultData resultData = null;
@@ -96,7 +102,8 @@ public class IntegralShoppingMallController {
     //获取油站积分商品详情信息
     @RequestMapping(value = "/getIntegralWaresInfo", method = RequestMethod.GET)
     @ResponseBody
-    public String getIntegralWaresInfo(@RequestParam Integer id){
+    @ApiOperation(value = "获取油站积分商品详细信息", httpMethod = "GET", notes = "油站积分商品详细信息")
+    public String getIntegralWaresInfo(@ApiParam(value = "商品ID", required = true)@RequestParam Integer id){
         Gson gson =new Gson();
         //返回结果集
         ResultData resultData = null;
@@ -115,7 +122,8 @@ public class IntegralShoppingMallController {
     //获取油站积分商品信息
     @RequestMapping(value = "/getIntegralWaresInfoList", method = RequestMethod.GET)
     @ResponseBody
-    public String getIntegralWaresInfoList(@RequestParam Integer stationId){
+    @ApiOperation(value = "获取油站积分商品列信息", httpMethod = "GET", notes = "油站积分商品列信息")
+    public String getIntegralWaresInfoList(@ApiParam(value = "油站ID", required = true) @RequestParam Integer stationId){
         Gson gson =new Gson();
         //返回结果集
         ResultData resultData = null;
@@ -140,6 +148,7 @@ public class IntegralShoppingMallController {
     @RequestMapping(value = "/insertIntegralOrder", method = RequestMethod.POST)
     @ResponseBody
     @Transactional
+    @ApiOperation(value = "生成积分订单", httpMethod = "POST", notes = "生成积分订单")
     public String insertIntegralOrder(@RequestBody IntegralOrder request){
         logger.info("生成订单所传递参数："+ request.toString());
         Gson gson =new Gson();
@@ -407,7 +416,9 @@ public class IntegralShoppingMallController {
     //获取用户积分订单列表
     @RequestMapping(value = "/getUserIntegralOrderList", method = RequestMethod.GET)
     @ResponseBody
-    public String getUserIntegralOrderList(@RequestParam String unionId, Integer stationId){
+    @ApiOperation(value = "获取用户积分订单列表", httpMethod = "GET", notes = "用户积分订单列表")
+    public String getUserIntegralOrderList(@ApiParam(value = "客户unionId", required = true)@RequestParam String unionId,
+                                           @ApiParam(value = "油站ID", required = true)@RequestParam Integer stationId){
         Gson gson =new Gson();
         //返回结果集
         ResultData resultData = null;
@@ -426,7 +437,9 @@ public class IntegralShoppingMallController {
     //获取客户积分信息
     @RequestMapping(value = "/getCustomerPointsInfo", method = RequestMethod.GET)
     @ResponseBody
-    public String getCustomerPointsInfo(@RequestParam String unionId, Integer stationId){
+    @ApiOperation(value = "获取客户积分信息", httpMethod = "GET", notes = "获取客户积分信息")
+    public String getCustomerPointsInfo(@ApiParam(value = "客户unionId", required = true)@RequestParam String unionId,
+                                        @ApiParam(value = "油站ID", required = true)@RequestParam Integer stationId){
         Gson gson =new Gson();
         //返回结果集
         ResultData resultData = null;
@@ -451,7 +464,9 @@ public class IntegralShoppingMallController {
     //获取客户积分记录信息
     @RequestMapping(value = "/getCustomerPointsRecordList", method = RequestMethod.GET)
     @ResponseBody
-    public String getCustomerPointsRecordList(@RequestParam String unionId, Integer stationId){
+    @ApiOperation(value = "获取客户积分记录信息", httpMethod = "GET", notes = "获取客户积分记录信息")
+    public String getCustomerPointsRecordList(@ApiParam(value = "客户unionId", required = true)@RequestParam String unionId,
+                                              @ApiParam(value = "油站ID", required = true)@RequestParam Integer stationId){
         Gson gson =new Gson();
         //返回结果集
         ResultData resultData = null;
@@ -475,7 +490,8 @@ public class IntegralShoppingMallController {
     //获取油站油品积分规则信息 根据油站ID和油品名称
     @RequestMapping(value = "/getIntegralRuleListByOilNameAndStationId", method = RequestMethod.GET)
     @ResponseBody
-    public String getIntegralRuleList(@RequestParam Integer stationId, String oilName, String oilType){
+    @ApiOperation(value = "获取油站油品积分规则信息 根据油站ID和油品名称", httpMethod = "GET", notes = "获取油站油品积分规则信息 根据油站ID和油品名称")
+    public String getIntegralRuleList(@ApiParam(value = "油站ID", required = true)@RequestParam Integer stationId, String oilName, String oilType){
         Gson gson =new Gson();
         //返回结果集
         ResultData resultData = null;
@@ -502,7 +518,8 @@ public class IntegralShoppingMallController {
     //获取油站积分规则信息 根据油站ID
     @RequestMapping(value = "/getIntegralRuleList", method = RequestMethod.GET)
     @ResponseBody
-    public String getIntegralRuleList(@RequestParam Integer stationId){
+    @ApiOperation(value = "获取油站积分规则信息", httpMethod = "GET", notes = "获取油站积分规则信息")
+    public String getIntegralRuleList(@ApiParam(value = "油站ID", required = true)@RequestParam Integer stationId){
         Gson gson =new Gson();
         //返回结果集
         ResultData resultData = null;

YijiaRestful/src/main/resources/application.yml

@@ -26,6 +26,20 @@ yijia:
 3des:
     pwd: LAnZ8RRSkIY0EGVYheu2IjEk
 
+# swagger2
+swagger2:
+    swagger-ui-open: true
+
+# swagger2 UI登录密码
+#security:
+#    basic:
+#        enabled: true
+#        path: /swagger-ui.html
+#    user:
+#        name: admin
+#        password: Admin@123#
+
+
 # Spring配置
 spring:
     datasource: