Swagger API文档Responses中Object类型无法显示,求指引

问题:Object类型和enum枚举值在API文档中展示异常
在这里插入图片描述

Result类

package com.dreamfuture.elearning.util;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.Serializable;

/**
 * 持续优化参考https://blog.csdn.net/WantFlyDaCheng/article/details/113874699
 */
@ApiModel
public class Result implements Serializable {

    static Logger logger = LoggerFactory.getLogger(Result.class);

    @ApiModelProperty(position = 0, value = "返回结果码")
    Object resultCode;
    @ApiModelProperty(position = 1, value = "返回数据体")
    Object data;


    /**
     * RestAPI成功应答报文
     *
     * @param data
     * @return {@code Result}
     */
    public static Result success(Object data) {
        Result result = Result.success();
        result.setData(data);

        return result;
    }

    /**
     * RestAPI成功应答报文
     *
     * @return {@code Result}
     */
    public static Result success() {
        Result result = new Result();
        result.setResultCode(ResultCode.SUCCESS);

        logger.info(System.currentTimeMillis() + " 成功");
        return result;
    }

    /**
     * RestAPI拦截应答
     *
     * @param response
     * @param resultCode
     * @return {@code HttpServletResponse}
     */
    public static HttpServletResponse handlerResponse(HttpServletResponse response, ResultCode resultCode) throws IOException {

        Result result = new Result();
        result.setResultCode(resultCode);
     

        logger.info(System.currentTimeMillis() + " " + resultCode.code() + resultCode.message());

        return response;
    }

    /**
     * RestAPI拦截应答
     *
     * @param response
     * @param resultCode
     * @param data
     * @return {@code HttpServletResponse}
     */
    public HttpServletResponse handlerResponse(HttpServletResponse response, Object resultCode, Object data) throws IOException {

        response.setCharacterEncoding("UTF-8");
        response.setContentType("application/json; charset=utf-8");
        Result result = new Result();
        result.setResultCode(resultCode);
        result.setData(data);

        response.getWriter().append(result.toString());

        return response;
    }

    /**
     * RestAPI失败应答报文
     *
     * @param resultCode
     * @param data
     * @return {@code Result}
     */
    public Result failure(Object resultCode, Object data) {
        Result result = new Result();
        result.setResultCode(resultCode);
        result.setData(data);
        return result;
    }

    /**
     * RestAPI失败应答报文
     *
     * @param resultCode
     * @return {@code Result}
     */
    public static Result failure(Object resultCode) {
        Result result = new Result();
        result.setResultCode(resultCode);
        return result;
    }

    public Object getResultCode() {
        return resultCode;
    }

    public void setResultCode(Object resultCode) {
        this.resultCode = resultCode;
    }

    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }
}

ResultCOde类

package com.dreamfuture.elearning.util;

import com.alibaba.fastjson.annotation.JSONField;
import com.alibaba.fastjson.annotation.JSONType;
import com.fasterxml.jackson.annotation.JsonFormat;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

/*@JSONType(serializeEnumAsJavaBean = true)*/
@ApiModel(value = "返回结果码")
@JsonFormat(shape = JsonFormat.Shape.OBJECT)/*支持枚举值类型JSON格式返回*/
public enum ResultCode {

    /*成功状态码*/
    SUCCESS(0, "成功"),
    /*1000~1999 区间表示参数错误*/
    USER_EXIST(1001, "用户名已使用,请输入未使用用户名"),
    /*2000~2999 区间表示用户错误*/
    USER_ERROR(2001, "用户账户或密码错误,登录失败"),
    USER_NOT_AUTH(2002, "尚未授权,请登录"),
    USER_AUTH_TIMEOUT(2003, "登录已失效,请重新登录"),
    /*3000~3999 区间表示接口异常*/
    FAIL(9999, "未知错误");


    //@JSONField(name = "code")
    @ApiModelProperty(value = "返回码",required = true)
    private Integer code;
    @ApiModelProperty(value = "返回码描述",required = true)
    private String message;

    ResultCode(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public Integer code() {
        return this.code;
    }

    public String message() {
        return this.message;
    }

    public Integer getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 5
    评论
【优质项目推荐】 1、项目代码均经过严格本地测试,运行OK,确保功能稳定后才上传平台。可放心下载并立即投入使用,若遇到任何使用问题,随时欢迎私信反馈与沟通,博主会第一时间回复。 2、项目适用于计算机相关专业(如计科、信息安全、数据科学、人工智能、通信、物联网、自动化、电子信息等)的在校学生、专业教师,或企业员工,小白入门等都适用。 3、该项目不仅具有很高的学习借鉴价值,对于初学者来说,也是入门进阶的绝佳选择;当然也可以直接用于 毕设、课设、期末大作业或项目初期立项演示等。 3、开放创新:如果您有一定基础,且热爱探索钻研,可以在此代码基础上二次开发,进行修改、扩展,创造出属于自己的独特应用。 欢迎下载使用优质资源!欢迎借鉴使用,并欢迎学习交流,共同探索编程的无穷魅力! 基于业务逻辑生成特征变量python实现源码+数据集+超详细注释.zip基于业务逻辑生成特征变量python实现源码+数据集+超详细注释.zip基于业务逻辑生成特征变量python实现源码+数据集+超详细注释.zip基于业务逻辑生成特征变量python实现源码+数据集+超详细注释.zip基于业务逻辑生成特征变量python实现源码+数据集+超详细注释.zip基于业务逻辑生成特征变量python实现源码+数据集+超详细注释.zip基于业务逻辑生成特征变量python实现源码+数据集+超详细注释.zip 基于业务逻辑生成特征变量python实现源码+数据集+超详细注释.zip 基于业务逻辑生成特征变量python实现源码+数据集+超详细注释.zip
提供的源码资源涵盖了安卓应用、小程序、Python应用和Java应用等多个领域,每个领域都包含了丰富的实例和项目。这些源码都是基于各自平台的最新技术和标准编写,确保了在对应环境下能够无缝运行。同时,源码配备了详细的注释和文档,帮助用户快速理解代码结构和实现逻辑。 适用人群: 这些源码资源特别适合大学生群体。无论你是计算机相关专业的学生,还是对其他领域编程感兴趣的学生,这些资源都能为你提供宝贵的学习和实践机会。通过学习和运行这些源码,你可以掌握各平台开发的基础知识,提升编程能力和项目实战经验。 使用场景及目标: 在学习阶段,你可以利用这些源码资源进行课程实践、课外项目或毕业设计。通过分析和运行源码,你将深入了解各平台开发的技术细节和最佳实践,逐步培养起自己的项目开发和问题解决能力。此外,在职或创业过程,具备跨平台开发能力的大学生将更具竞争力。 其他说明: 为了确保源码资源的可运行性和易用性,特别注意了以下几点:首先,每份源码都提供了详细的运行环境和依赖说明,确保用户能够轻松搭建起开发环境;其次,源码的注释和文档都非常完善,方便用户快速上手和理解代码;最后,我会定期更新这些源码资源,以适应各平台技术的最新发展和市场需

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值