EasyYapi接入简单实战

最新推荐文章于 2024-08-16 07:37:32 发布

至学者

最新推荐文章于 2024-08-16 07:37:32 发布

阅读量5.8k

点赞数 1

分类专栏：开发工具文章标签： yapi

本文链接：https://blog.csdn.net/calm_encode/article/details/121777688

版权

开发工具专栏收录该内容

34 篇文章 0 订阅

订阅专栏

一 EasyYapi

部署EasyYapi:

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

二 IDEA 安装Easy Yapi插件

三配置Yapi的Token

获取Token:

配置Token:

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

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

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

五代码格式

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

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

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