关于intellij-idea:Postcat-IDEA-插件最全的使用教程

11次阅读

共计 2071 个字符，预计需要花费 6 分钟才能阅读完成。

Postcat 插件不会入侵到代码外部，无需增加任何 jar 包依赖，这个真的很香！

上面说一说，这个插件如何应用，是时候展示真正的技术了~

IDEA 版本需大于 IntelliJ IDEA 2022.03

在 IDEA“设置 - 插件 -Marketplace”中搜寻 Postcat，找到 Postcat 插件装置即可。同时也可在 IDEA 插件市场 上进行下载安装，本地的 IDEA 没有主动唤起时，能够间接把 zip 包拖入 IDEA 中即可实现装置 / 更新。

填写配置信息

首次上传须要填写配置信息，配置信息我的项目之间独立。
配置信息获取路径：登陆 Postcat 进入我的项目中获取 Token、WorkspaceID 和 ProjectID。

Server 默认填写：https://postcat.com/api，用户无需批改
Token 获取
WorkspaceID 和 ProjectID 获取
1. 进入我的项目设置页面，点击我的项目名右侧“问号”

StringType 决定出入参的字符串类型，只有参数名一开始就是恪守驼峰标准才会发现扭转，预览窗口可看到变动后果
1. 当参数名为 userInfo，抉择 camelCase，仍旧是 userInfo，这是默认选项
2. 当参数名为 userInfo，抉择 lower_underscore，会变成 user_info
3. 当参数名为 userInfo，抉择 UPPER_UNDERSCORE，会变成 USER_INFO

进行解析上传前，请确保 IDEA 在我的项目中曾经构建完，相干依赖曾经下载好。
强烈推荐应用插件定义的正文，插件有弱小的生成正文性能，强烈建议学生成插件的正文进行编辑再上传，正文能够在设置也进行自定义。
在辨认不到插件正文时，仅对 Spring MVC、Swagger.v2 和 Swagger(OpenAPI).v3 的注解只做局部简略反对。为防止必要参数的缺失，举荐应用插件正文。
生成正文性能会对 Spring MVC、Swagger.v2 和 Swagger(OpenAPI).v3 的注解只做局部简略反对，而不会让你重头编写。
HTTP 接口通过路由和申请形式判断惟一做笼罩更新解决
对于曾经上传的 API，在 web 上进行过手动批改，不倡议再应用上传性能，因为插件上传会笼罩掉之前的内容。
在生成 / 手敲了插件 javadoc 后，对接口 uri，申请形式（GET/POST）等做了批改，须要手动批改插件 javadoc，否则插件还是会辨认到旧的插件 javadoc 信息。
主动生成的类正文默认会上传到默认分组，请用户自行填写实在的分组，分组通过名字辨认。
1. 如多级分组，则用. 隔开，比方须要把接口传到第三方分组下的用户分组，则 group-name 填写第三方. 用户。
@group-name 正文反对到办法级别，默认不生成，可手动增加到办法正文，插件会帮你将以后办法存到对应分组中。
我的项目级别的 api 扫描和上传，顶部菜单[Tools -> Upload Project Api Doc]，具体应用规定看我的项目级上传。
生成类正文不在默认生成 @required 正文，只会针对有 javax.validation.constraints.NotNull 注解的字段才生成。
不举荐应用 @remark 正文，插件保留了辨认性能且将内容拼接到字段阐明中，生成类正文不会主动生成。
通过 @PathVariable，POST 办法默认把参数辨认成 Formdata 类型，GET 办法默认把参数辨认成 query 类型。
// 标识的正文无奈被辨认进去，请应用 /* / 标识。