cxc/yshopb2c
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

新增对swagger 增强 ,响应参数返回注解内容

Browse Source
This commit is contained in:
LionCity
2020-06-02 18:47:00 +08:00
parent b6db4bac80
commit 55c1ac9771
10 changed files with 42 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
yshop-api/src/main/java/co/yixiang/common/api/ApiResult.java
View File

@ -41,27 +41,27 @@ public class ApiResult<T> implements Serializable {
}
public static ApiResult result(boolean flag){
public static <T> ApiResult<T> result(boolean flag){
if (flag){
return ok();
}
return fail("");
}
public static ApiResult result(ApiCode apiCode){
public static <T> ApiResult<T> result(ApiCode apiCode){
return result(apiCode,null);
}
public static ApiResult result(ApiCode apiCode,Object data){
public static <T> ApiResult<T> result(ApiCode apiCode,T data){
return result(apiCode,null,data);
}
public static ApiResult result(ApiCode apiCode,String msg,Object data){
public static <T> ApiResult<T> result(ApiCode apiCode,String msg,T data){
String message = apiCode.getMsg();
if (StringUtils.isNotBlank(msg)){
message = msg;
}
return ApiResult.builder()
return (ApiResult<T>) ApiResult.builder()
.status(apiCode.getCode())
.msg(message)
.data(data)
@ -69,34 +69,34 @@ public class ApiResult<T> implements Serializable {
.build();
}
public static ApiResult ok(){
public static <T> ApiResult<T> ok(){
return ok(null);
}
public static ApiResult ok(Object data){
public static <T> ApiResult<T> ok(T data){
return result(ApiCode.SUCCESS,data);
}
public static ApiResult ok(Object data,String msg){
public static <T> ApiResult<T> ok(T data,String msg){
return result(ApiCode.SUCCESS,msg,data);
}
public static ApiResult ok(String key,Object value){
Map<String,Object> map = new HashMap<>();
map.put(key,value);
return ok(map);
}
// public static <T> ApiResult<T> ok(String key,T value){
// Map<String,T> map = new HashMap<>();
// map.put(key,value);
// return ok(map);
// }
public static ApiResult fail(ApiCode apiCode){
public static <T> ApiResult<T> fail(ApiCode apiCode){
return result(apiCode,null);
}
public static ApiResult fail(String msg){
public static <T> ApiResult<T> fail(String msg){
return result(ApiCode.FAIL,msg,null);
}
public static ApiResult fail(ApiCode apiCode,Object data){
public static <T> ApiResult<T> fail(ApiCode apiCode,T data){
if (ApiCode.SUCCESS == apiCode){
throw new RuntimeException("失败结果状态码不能为" + ApiCode.SUCCESS.getCode());
}
@ -104,10 +104,10 @@ public class ApiResult<T> implements Serializable {
}
public static ApiResult fail(String key,Object value){
Map<String,Object> map = new HashMap<>();
map.put(key,value);
return result(ApiCode.FAIL,map);
}
// public static <T> ApiResult<T> fail(String key,T value){
// Map<String,T> map = new HashMap<>();
// map.put(key,value);
// return result(ApiCode.FAIL,map);
// }
}

3
yshop-api/src/main/java/co/yixiang/modules/activity/web/controller/StoreBargainController.java
View File

@ -26,6 +26,7 @@ import co.yixiang.modules.activity.entity.YxStoreBargainUserHelp;
import co.yixiang.modules.activity.service.YxStoreBargainService;
import co.yixiang.modules.activity.service.YxStoreBargainUserHelpService;
import co.yixiang.modules.activity.service.YxStoreBargainUserService;
import co.yixiang.modules.activity.web.dto.BargainDTO;
import co.yixiang.modules.activity.web.param.YxStoreBargainQueryParam;
import co.yixiang.modules.activity.web.param.YxStoreBargainUserQueryParam;
import co.yixiang.modules.activity.web.vo.YxStoreBargainQueryVo;
@ -111,7 +112,7 @@ public class StoreBargainController extends BaseController {
@Log(value = "查看砍价产品",type = 1)
@GetMapping("/bargain/detail/{id}")
@ApiOperation(value = "砍价详情",notes = "砍价详情",response = YxStoreBargainQueryVo.class)
public ApiResult<YxStoreBargainQueryVo> getYxStoreBargain(@PathVariable Integer id){
public ApiResult<BargainDTO> getYxStoreBargain(@PathVariable Integer id){
if(ObjectUtil.isNull(id)) return ApiResult.fail("参数错误");
int uid = SecurityUtils.getUserId().intValue();
return ApiResult.ok(storeBargainService.getDetail(id,uid));

4
yshop-api/src/main/java/co/yixiang/modules/order/web/controller/StoreOrderController.java
View File

@ -201,7 +201,7 @@ public class StoreOrderController extends BaseController {
*/
@PostMapping("/order/create/{key}")
@ApiOperation(value = "订单创建",notes = "订单创建")
public ApiResult<ConfirmOrderDTO> create(@Valid @RequestBody OrderParam param,
public ApiResult<Map<String,Object>> create(@Valid @RequestBody OrderParam param,
@PathVariable String key){
Map<String,Object> map = new LinkedHashMap<>();
@ -359,7 +359,7 @@ public class StoreOrderController extends BaseController {
@Log(value = "订单支付",type = 1)
@PostMapping("/order/pay")
@ApiOperation(value = "订单支付",notes = "订单支付")
public ApiResult<ConfirmOrderDTO> pay(@Valid @RequestBody PayParam param){
public ApiResult<Map<String,Object>> pay(@Valid @RequestBody PayParam param){
Map<String,Object> map = new LinkedHashMap<>();
int uid = SecurityUtils.getUserId().intValue();

2
yshop-api/src/main/java/co/yixiang/modules/security/rest/AuthController.java
View File

@ -97,7 +97,7 @@ public class AuthController {
@ApiOperation("H5/APP登录授权")
@AnonymousAccess
@PostMapping(value = "/login")
public ApiResult<Map<String, String>> login(@Validated @RequestBody AuthUser authUser,
public ApiResult< Map<String, Object>> login(@Validated @RequestBody AuthUser authUser,
HttpServletRequest request) {
UsernamePasswordAuthenticationToken authenticationToken =
new UsernamePasswordAuthenticationToken(authUser.getUsername(), authUser.getPassword());

4
yshop-api/src/main/java/co/yixiang/modules/shop/web/controller/ArticleController.java
View File

@ -25,6 +25,8 @@ import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
/**
* <p>
* 文章 前端控制器
@ -61,7 +63,7 @@ public class ArticleController extends BaseController {
@AnonymousAccess
@GetMapping("/list")
@ApiOperation(value = "文章列表",notes = "文章列表",response = YxArticleQueryVo.class)
public ApiResult<Paging<YxArticleQueryVo>> getYxArticlePageList(YxArticleQueryParam queryParam){
public ApiResult<List<YxArticleQueryVo>> getYxArticlePageList(YxArticleQueryParam queryParam){
Paging<YxArticleQueryVo> paging = articleService.getYxArticlePageList(queryParam);
return ApiResult.ok(paging.getRecords());
}

2
yshop-api/src/main/java/co/yixiang/modules/shop/web/controller/IndexController.java
View File

@ -111,7 +111,7 @@ public class IndexController {
@AnonymousAccess
@GetMapping("/citys")
@ApiOperation(value = "获取城市json",notes = "获取城市json")
public ApiResult<String> cityJson(){
public ApiResult<JSONObject> cityJson(){
String path = "city.json";
String name = "city.json";
try {

5
yshop-api/src/main/java/co/yixiang/modules/shop/web/controller/StoreCategoryController.java
View File

@ -14,6 +14,7 @@ import co.yixiang.common.web.controller.BaseController;
import co.yixiang.common.web.vo.Paging;
import co.yixiang.modules.shop.service.YxStoreCategoryService;
import co.yixiang.modules.shop.web.vo.YxStoreCategoryQueryVo;
import co.yixiang.utils.CateDTO;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
@ -22,6 +23,8 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
/**
* <p>
* 商品分类前端控制器
@ -45,7 +48,7 @@ public class StoreCategoryController extends BaseController {
@AnonymousAccess
@GetMapping("/category")
@ApiOperation(value = "商品分类列表",notes = "商品分类列表")
public ApiResult<Paging<YxStoreCategoryQueryVo>> getYxStoreCategoryPageList(){
public ApiResult<List<CateDTO>> getYxStoreCategoryPageList(){
return ApiResult.ok(yxStoreCategoryService.getList());
}

8
yshop-api/src/main/java/co/yixiang/modules/shop/web/controller/StoreProductController.java
View File

@ -26,9 +26,11 @@ import co.yixiang.modules.shop.service.YxStoreProductReplyService;
import co.yixiang.modules.shop.service.YxStoreProductService;
import co.yixiang.modules.shop.service.YxSystemConfigService;
import co.yixiang.modules.shop.web.dto.ProductDTO;
import co.yixiang.modules.shop.web.dto.ReplyCountDTO;
import co.yixiang.modules.shop.web.param.YxStoreProductQueryParam;
import co.yixiang.modules.shop.web.param.YxStoreProductRelationQueryParam;
import co.yixiang.modules.shop.web.vo.YxStoreProductQueryVo;
import co.yixiang.modules.shop.web.vo.YxStoreProductReplyQueryVo;
import co.yixiang.modules.user.entity.YxSystemAttachment;
import co.yixiang.modules.user.service.YxSystemAttachmentService;
import co.yixiang.modules.user.service.YxUserService;
@ -281,8 +283,8 @@ public class StoreProductController extends BaseController {
*/
@GetMapping("/reply/list/{id}")
@ApiOperation(value = "获取产品评论",notes = "获取产品评论")
public ApiResult<Object> replyList(@PathVariable Integer id,
YxStoreProductQueryParam queryParam){
public ApiResult<List<YxStoreProductReplyQueryVo>> replyList(@PathVariable Integer id,
YxStoreProductQueryParam queryParam){
return ApiResult.ok(replyService.getReplyList(id,Integer.valueOf(queryParam.getType()),
queryParam.getPage().intValue(),queryParam.getLimit().intValue()));
}
@ -292,7 +294,7 @@ public class StoreProductController extends BaseController {
*/
@GetMapping("/reply/config/{id}")
@ApiOperation(value = "获取产品评论数据",notes = "获取产品评论数据")
public ApiResult<Object> replyCount(@PathVariable Integer id){
public ApiResult<ReplyCountDTO> replyCount(@PathVariable Integer id){
return ApiResult.ok(replyService.getReplyCount(id));
}

3
yshop-api/src/main/java/co/yixiang/modules/user/web/controller/UserAddressController.java
View File

@ -35,6 +35,7 @@ import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
@ -129,7 +130,7 @@ public class UserAddressController extends BaseController {
@Log(value = "查看地址",type = 1)
@GetMapping("/address/list")
@ApiOperation(value = "用户地址列表",notes = "用户地址列表",response = YxUserAddressQueryVo.class)
public ApiResult<Paging<YxUserAddressQueryVo>> getYxUserAddressPageList(YxUserAddressQueryParam queryParam){
public ApiResult<List<YxUserAddressQueryVo>> getYxUserAddressPageList(YxUserAddressQueryParam queryParam){
int uid = SecurityUtils.getUserId().intValue();
queryParam.setUid(uid);
queryParam.setIsDel(0);

2
yshop-api/src/main/java/co/yixiang/modules/wechat/web/controller/WxMaUserController.java
View File

@ -88,7 +88,7 @@ public class WxMaUserController {
@PostMapping("/wxapp/binding")
@ApiOperation(value = "小程序绑定手机号", notes = "小程序绑定手机号")
public ApiResult<String> phone(@Validated @RequestBody WxPhoneParam param) {
public ApiResult<Map<String,Object>> phone(@Validated @RequestBody WxPhoneParam param) {
int uid = SecurityUtils.getUserId().intValue();
YxUserQueryVo userQueryVo = userService.getYxUserById(uid);