EasyYapi接入简单实战

一 EasyYapi

        部署EasyYapi:

        参考：Yapi&easyapi文档管理平台安装与使用_程序男的专栏-CSDN博客_easyyapihttps://blog.csdn.net/u010504064/article/details/112055903

二 IDEA 安装Easy Yapi插件        

 三 配置Yapi的Token

        获取Token:

         配置Token:    ​​

        ​​​​​

        注意：可以token窗口可以配置多个项目的token。

四 导出API到Yapi,有四种方法 

1.         打开spring项目中的Controller文件或者在IDEA的左边项目文件区域选择文件或者文件夹 使用快捷键"alt shift E(windows)/ctrl E(mac)" 然后选择要导出的API,选择导出渠道为yapi 点击[✔]按钮或者按回车键完成导出。
2.         打开spring项目中的Controller文件 右键文件内容选择generate...或者用"[Alt + Insert]/[Ctrl+Enter](快捷键可能不一样)" 然后选择"ExportYapi"。
3.         在IDEA的左边项目文件区域选择文件或者文件夹 鼠标点击最上方[Code -> ExportYapi]。
4.         鼠标点击最上方[Code -> YapiDashBoard] 然后就可以用鼠标将左边的API拖动到右边yapi目录中。

五 代码格式

/**
 *  测试接入Yapi文档管理
 */
@RestController
@RequestMapping("/test")
public class TestController {

    /**
     * 测试接口
     * @return 测试返回值
     */
    @GetMapping("/yapi")
    public String test() {
        return "test yapi for springboot";
    }
}

         注：尽量按这种注释格式，本人使用其他格式出了一些意想不到的问题，暂时还不知道具体原因，后续补充。。。