metersphere/metersphere-idea-plugin

metersphere-idea-plugin

支持导出 HTTP 接口到 MeterSphere.

Features：

• Javadoc-based analysis,no additional annotations.
• Automatically identify classes, generate api documents to MeterSphere.
• Support list, set, collection and other data structures, and support nested generic parsing.
• Support the parsing of common annotations such as @ResponseBody, @RequestMapping, and generate api documents based on json5.

Usage：

• Locate the cursor to the package/project folder or class, right-click Export MeterSphere.
• Support annotations：

  org.springframework.web.bind.annotation.Controller org.springframework.web.bind.annotation.RestController org.springframework.web.bind.annotation.RequestMapping org.springframework.web.bind.annotation.GetMapping org.springframework.web.bind.annotation.PutMapping org.springframework.web.bind.annotation.DeleteMapping org.springframework.web.bind.annotation.PatchMapping org.springframework.web.bind.annotation.PathVariable org.springframework.web.bind.annotation.RequestBody org.springframework.web.bind.annotation.RequestParam org.springframework.web.bind.annotation.ResponseBody

特性：

• 基于javadoc解析，无代码入侵
• 自动识别类，生成接口定义到 MeterSphere
• 支持List、Set、Collection等数据结构，支持嵌套泛型解析
• 支持@ResponseBody等常用注解的解析

安装方式：

• 直接在 idea -> Settings -> plugins -> Marketplace 搜索 MeterSphere 在线安装
• 下载离线包
  idea -> Settings -> plugins -> 选择下载的插件 -> Install Plugin from Disk

用法：

• 将光标定位到项目/包级目录或者打开类，鼠标右键单击"Export MeterSphere".
• 自定义配置项： Preferences —> Other Settings —> MeterSphere

配置项	含义
apiServer	MeterSphere API 服务器地址
accesskey	accesskey
secretkey	secretkey
protocol	协议
workspace	工作空间
project	项目
module	接口将要导入的项目对应的模块
mode	覆盖/不覆盖已导入同名接口
object-deepth	针对接口中含有复杂嵌套对象的解析深度
version	新增接口建立的版本号
update-version	覆盖接口所生成的版本号
context-path	接口路径前缀
export-name	导出的模块名称
javadoc	支持读取接口/类名前注释的 javadoc 作为接口名称
coverModule	选择覆盖的同时是否一并更新旧接口的模块

Compatible IDE versions: 2020.3+

问题反馈

如果您在使用过程中遇到什么问题，或有进一步的需求需要反馈，请提交 GitHub Issue 到 MeterSphere 项目的主仓库