可视化接口管理平台-yapi使用方式

最新推荐文章于 2024-07-29 21:07:24 发布

zhuiqi

最新推荐文章于 2024-07-29 21:07:24 发布

阅读量483

点赞数 1

分类专栏：可视化接口管理平台 idea插件文章标签：接口文档管理 yapi

本文链接：https://blog.csdn.net/zhuiqi/article/details/107359779

版权

本文介绍了YApi接口管理平台的Idea插件使用步骤，包括从GitHub下载jar包安装、配置信息以及上传接口的方法。同时，详细阐述了插件的规则，如通过注释生成属性备注、接口名称，@link参数展示，自定义分类以及支持的注解。良好的JavaDoc注释对于生成高质量的接口文档至关重要。

摘要由CSDN通过智能技术生成

idea插件使用方式

1: 在github disk 中下载最新的jar包 (或者在idea 插件库中搜索安装）

2: 如果是下载的jar 需要打开idea preferneces->plugins-> install plugin from disk,导入jar 包后(install)，重启

3: 配置信息

3.1: 配置信息位置, 在项目目录下，.idea 文件夹下，找到misc.xml (如果找不到.idea 请查看是否被折叠或被隐藏) 如果是 .ipr 模式创建的就找到项目名.ipr

3.2: 单模块配置

<component name="yapi">
  <option name="projectToken">yapi 中项目token</option>
  <option name="projectId">yapi 中项目id</option>
  <option name="yapiUrl">http://127.0.0.1:3000</option>
  <option name="projectType">api</option>
  <option name="attachUploadUrl">http://localhost/fileupload</option><!-- 这条可不用配置-->
</component>