springboot接口被统一包装结果类、加前缀后缀名的文档自动导出问题解决方案

背景介绍：我们的接口返回的对象全部会被统一结果对象再包一层，因此直接用插件导出接口文档是不方便的，结构和真实响应结果不一致。另外我们这所有的接口会被自动加上.do的后缀才能访问。本次方案就是来解决这两个特性在接口文档导出方面产生的问题，最后实现一次性完成正确的导出接口文档。

第一步安装IDEA插件 EasyYapi

第二步配置EasyYapi插件

第三步插件自定义配置

那个统一的包装类路径你要换成你自己的

method.return=groovy: “com.zhenai.framework.base.response.ReturnResponse<” + it.returnType() +“>”
json.rule.field.ignore=groovy:it.hasModifier(“transient”)||it.hasModifier(“static”)
export.after=groovy:api.setPath(api.path()+“.do”)

接口代码

import com.zhenai.quyue.api.request.config.DemoRequest;
import com.zhenai.quyue.api.response.config.DemoResponse;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * 测试接口
 *
 * @author humorchen
 * @date 2023/1/31 19:01
 */
@Controller
@RequestMapping("test/response")
public class ResponseTestAction {
    /**
     * 示范接口
     *
     * @param demoRequest
     * @return
     */
    @RequestMapping("demo")
    DemoResponse demo(DemoRequest demoRequest) {
        return new DemoResponse().setAnswer("问题：" + demoRequest.getQuestion() + " 我现在还不会~");
    }
}

接口请求

/**
 *
 * @author humorchen
 * @date 2023/1/31 19:22
 */
public class DemoRequest {
    /**
     * 你的问题
     */
    private String question;

    public String getQuestion() {
        return question;
    }

    public DemoRequest setQuestion(String question) {
        this.question = question;
        return this;
    }
}

接口响应类

/**
 *
 * @author humorchen
 * @date 2023/1/31 19:02
 */
public class DemoResponse implements IResponse {
    /**
     * 答案
     */
    private String answer;

    public String getAnswer() {
        return answer;
    }

    public DemoResponse setAnswer(String answer) {
        this.answer = answer;
        return this;
    }
}

响应统一的包装类

public class ReturnResponse<T> {

    @JSONField(name = "isError")
    private boolean isError = false;

    private String errorCode = "";

    private String errorMessage = "";

    private T data;
}