Swagger2 生成API文档时泛型总是显示不出来的问题

傷城~ 2022-08-30 11:37 418阅读 0赞

## \#\# 接口响应消息体 ##

/* * * Copyright (c) 2018-2025, lengleng All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * Neither the name of the hzcloud.com developer nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * Author: lengleng (wangiegie@gmail.com) * */
    
    package com.hzcloud.hz.common.core.util;
    
    import com.hzcloud.hz.common.core.constant.CommonConstants;
    import io.swagger.annotations.ApiModel;
    import io.swagger.annotations.ApiModelProperty;
    import lombok.*;
    import lombok.experimental.Accessors;
    
    import java.io.Serializable;
    
    /** * 响应信息主体 * * @param <T> * @author lengleng */
    @ToString
    @NoArgsConstructor
    @AllArgsConstructor
    @Accessors(chain = true)
    @ApiModel(value = "响应信息主体")
    public class R<T> implements Serializable { 
    	private static final long serialVersionUID = 1L;
    
    	@Getter
    	@Setter
    	@ApiModelProperty(value = "返回标记：成功标记=0，失败标记=1")
    	private int code;
    
    	@Getter
    	@Setter
    	@ApiModelProperty(value = "返回信息")
    	private String msg;
    
    
    	@Getter
    	@Setter
    	@ApiModelProperty(value = "数据")
    	private T data;
    
    	public static <T> R<T> ok() { 
    		return restResult(null, CommonConstants.SUCCESS, null);
    	}
    
    	public static <T> R<T> ok(T data) { 
    		return restResult(data, CommonConstants.SUCCESS, null);
    	}
    
    	public static <T> R<T> ok(T data, String msg) { 
    		return restResult(data, CommonConstants.SUCCESS, msg);
    	}
    
    	public static <T> R<T> failed() { 
    		return restResult(null, CommonConstants.FAIL, null);
    	}
    
    	public static <T> R<T> failed(String msg) { 
    		return restResult(null, CommonConstants.FAIL, msg);
    	}
    
    	public static <T> R<T> failed(T data) { 
    		return restResult(data, CommonConstants.FAIL, null);
    	}
    
    	public static <T> R<T> failed(T data, String msg) { 
    		return restResult(data, CommonConstants.FAIL, msg);
    	}
    
    	private static <T> R<T> restResult(T data, int code, String msg) { 
    		R<T> apiResult = new R<>();
    		apiResult.setCode(code);
    		apiResult.setData(data);
    		apiResult.setMsg(msg);
    		return apiResult;
    	}
    }

## \#\# 使用：在接口返回值后加上类的名称 ##

\#如下返回值为 R 这个Integer就是类型名称

/** * 查询未完成的场次的数量 * @return 未完成的场次的数量 */
    	@GetMapping("/queryUnfinishedImplementationCount")
    	@ApiOperation(value = "查询未完成的场次的数量", notes = "查询未完成的场次的数量")
    	public R<Integer> getById() { 
    		QueryWrapper<FlightplanSet> flightplanSetQueryWrapper=new QueryWrapper<>();
    		flightplanSetQueryWrapper.eq("implementation_status",Constants.FLIGHT_PLAN_SET_IMPLEMENTATION_STATUS_OF_UNFINISHED);
    		flightplanSetQueryWrapper.eq("del_flag",Constants.DEL_FLAG_NORMAL);
    		return R.ok(flightplanSetService.count(flightplanSetQueryWrapper));
    	}

## 结果，swagger就会生成带有返回结构的响应体 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE4NjcxNDE1_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE4NjcxNDE1_size_16_color_FFFFFF_t_70]: /images/20220829/aa8ae4e84f4f49f0aa209188c7bcda8e.png