swagger

src/main/java/com/huiju/estateagents/controller/TaGoodsController.java

@@ -13,6 +13,10 @@ import com.huiju.estateagents.entity.TaPerson;
 import com.huiju.estateagents.service.ITaBuildingService;
 import com.huiju.estateagents.service.ITaGoodsService;
 import com.huiju.estateagents.service.ITaPersonService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -40,6 +44,7 @@ import java.util.Map;
  */
 @RestController
 @RequestMapping("/api")
+@Api(value = "商品", tags = "商品")
 public class TaGoodsController extends BaseController {
 
     private final Logger logger = LoggerFactory.getLogger(TaGoodsController.class);
@@ -59,6 +64,16 @@ public class TaGoodsController extends BaseController {
      * @param pageSize
      * @return
      */
+    @ApiOperation(value = "后台商品列表", notes = "后台商品列表")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "goodsName", paramType = "query",value = "商品名称"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "buildingId", paramType = "query",value = "项目id"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "priceLesser", paramType = "query",value = "价格小"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "priceGreater", paramType = "query",value = "价格大"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "status", paramType = "query",value = "状态")
+    })
     @RequestMapping(value="/admin/taGoods",method= RequestMethod.GET)
     public ResponseBean taGoodsList(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
                                     @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize,
@@ -95,6 +110,10 @@ public class TaGoodsController extends BaseController {
      * @param taGoods 实体对象
      * @return
      */
+    @ApiOperation(value = "后台商品保存", notes = "后台商品保存")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "TaGoods", name = "taGoods", paramType = "body",value = "商品详细数据")
+    })
     @RequestMapping(value="/admin/taGoods/add",method= RequestMethod.POST)
     public ResponseBean taGoodsAdd(@RequestBody TaGoods taGoods,HttpServletRequest request){
         ResponseBean responseBean = new ResponseBean();
@@ -143,6 +162,10 @@ public class TaGoodsController extends BaseController {
      * @param taGoods 实体对象
      * @return
      */
+    @ApiOperation(value = "后台商品修改", notes = "后台商品修改")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "TaGoods", name = "taGoods", paramType = "body",value = "商品详细数据")
+    })
     @RequestMapping(value="/admin/taGoods",method= RequestMethod.PUT)
     public ResponseBean taGoodsUpdate(@RequestBody TaGoods taGoods,HttpServletRequest request){
         ResponseBean responseBean = new ResponseBean();
@@ -169,6 +192,10 @@ public class TaGoodsController extends BaseController {
      * @param taGoods 实体对象
      * @return
      */
+    @ApiOperation(value = "后台商品状态变更", notes = "后台商品状态变更")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "TaGoods", name = "taGoods", paramType = "body",value = "商品详细数据")
+    })
     @RequestMapping(value="/admin/taGoods/change",method= RequestMethod.PUT)
     public ResponseBean taGoodsChange(@RequestBody TaGoods taGoods,HttpServletRequest request){
         ResponseBean responseBean = new ResponseBean();
@@ -196,6 +223,10 @@ public class TaGoodsController extends BaseController {
      * 根据id查询对象
      * @param id  实体ID
      */
+    @ApiOperation(value = "后台商品详情", notes = "后台商品详情")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "path",value = "商品id")
+    })
     @RequestMapping(value="/admin/taGoods/{id}",method= RequestMethod.GET)
     public ResponseBean taGoodsGet(@PathVariable Integer id){
         ResponseBean responseBean = new ResponseBean();
@@ -215,6 +246,12 @@ public class TaGoodsController extends BaseController {
      * @param pageSize
      * @return
      */
+    @ApiOperation(value = "微信商品列表", notes = "微信商品列表")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "buildingId", paramType = "query",value = "项目id")
+    })
     @RequestMapping(value="/wx/goods",method= RequestMethod.GET)
     public ResponseBean wxGoodsList(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
                                     @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize,
@@ -260,6 +297,10 @@ public class TaGoodsController extends BaseController {
      * 根据id查询对象
      * @param id  实体ID
      */
+    @ApiOperation(value = "微信商品详情", notes = "微信商品详情")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "path",value = "商品id")
+    })
     @RequestMapping(value="/wx/goods/{id}",method= RequestMethod.GET)
     public ResponseBean wxGoodsGet(@PathVariable Integer id){
         ResponseBean responseBean = new ResponseBean();
@@ -279,6 +320,10 @@ public class TaGoodsController extends BaseController {
      * @param request
      * @return
      */
+    @ApiOperation(value = "微信兑换商品接口", notes = "微信兑换商品接口")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "path",value = "商品id")
+    })
     @RequestMapping(value="/wx/goods/exchange/{id}",method= RequestMethod.POST)
     public ResponseBean wxExchangeGoods(@PathVariable Integer id, HttpServletRequest request){
         ResponseBean responseBean = new ResponseBean();

src/main/java/com/huiju/estateagents/controller/TdPointsRulesController.java

@@ -8,6 +8,10 @@ import com.huiju.estateagents.base.ResponseBean;
 import com.huiju.estateagents.common.CommConstant;
 import com.huiju.estateagents.entity.TdPointsRules;
 import com.huiju.estateagents.service.ITdPointsRulesService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -32,6 +36,7 @@ import javax.servlet.http.HttpServletRequest;
  */
 @RestController
 @RequestMapping("/api")
+@Api(value = "积分", tags = "积分")
 public class TdPointsRulesController extends BaseController {
 
     private final Logger logger = LoggerFactory.getLogger(TdPointsRulesController.class);
@@ -46,6 +51,13 @@ public class TdPointsRulesController extends BaseController {
      * @param pageSize
      * @return
      */
+    @ApiOperation(value = "后台积分列表", notes = "后台积分列表")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "buildingId", paramType = "query",value = "项目id"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "type", paramType = "query",value = "类型")
+    })
     @RequestMapping(value="/admin/tdPointsRules",method= RequestMethod.GET)
     public ResponseBean tdPointsRulesList(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
                                           @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize,
@@ -83,6 +95,13 @@ public class TdPointsRulesController extends BaseController {
      * @param pageSize
      * @return
      */
+    @ApiOperation(value = "微信积分列表", notes = "微信积分列表")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "buildingId", paramType = "query",value = "项目id"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "type", paramType = "query",value = "类型")
+    })
     @RequestMapping(value="/wx/tdPointsRules",method= RequestMethod.GET)
     public ResponseBean tdWxPointsRulesList(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
                                             @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize,
@@ -165,6 +184,10 @@ public class TdPointsRulesController extends BaseController {
      * @param tdPointsRules 实体对象
      * @return
      */
+    @ApiOperation(value = "后台积分规则修改", notes = "后台积分规则修改")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "TdPointsRules", name = "tdPointsRules", paramType = "body",value = "积分详细数据")
+    })
     @RequestMapping(value="/admin/tdPointsRules",method= RequestMethod.PUT)
     public ResponseBean tdPointsRulesUpdate(@RequestBody TdPointsRules tdPointsRules){
         ResponseBean responseBean = new ResponseBean();
@@ -187,6 +210,10 @@ public class TdPointsRulesController extends BaseController {
      * @param tdPointsRules 实体对象
      * @return
      */
+    @ApiOperation(value = "后台积分规则停用启用", notes = "后台积分规则停用启用")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "TdPointsRules", name = "tdPointsRules", paramType = "body",value = "积分详细数据")
+    })
     @RequestMapping(value="/admin/tdPointsRules/change",method= RequestMethod.PUT)
     public ResponseBean tdPointsRulesChange(@RequestBody TdPointsRules tdPointsRules){
         ResponseBean responseBean = new ResponseBean();
@@ -213,6 +240,10 @@ public class TdPointsRulesController extends BaseController {
      * 根据id查询对象
      * @param id  实体ID
      */
+    @ApiOperation(value = "后台积分规则详情", notes = "后台积分规则详情")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "path",value = "积分id")
+    })
     @RequestMapping(value="/admin/tdPointsRules/{id}",method= RequestMethod.GET)
     public ResponseBean tdPointsRulesGet(@PathVariable Integer id){
         ResponseBean responseBean = new ResponseBean();