当有接口对接需求的时候，开发终于不用再担心 API 文档难写了，也不用再一个个接口文档重新写！安装这个 IDEA 插件，可以一步将文档导入到 Postcat。

和Swagger 有什么区别呢？

• 对于首次使用Postcat的现有项目，开发者可以使用主菜单中 Tools分组下的 Upload Project Api Doc来完成项目级别的接口上传。
• 对于新需求下创建的Controller，在完成接口定义后，开发者可以右键菜单，选择 Upload All Api 来进行单个文件级别全部上传，做到先有文档再有逻辑，前后端工作不再串行阻塞。
• 对于某个部分单独接口的改动，无需全部上传，开发者可以右键菜单，选择 Upload Api功能，该功能会展示当前编辑类的接口信息，并提供接口预览和接口选择界面，使得用户可以勾选需要更新或上传的目标API进行信息核对和上传。

如何安装配置？

IDEA 版本需大于 IntelliJ IDEA 2022.03

1. 填写配置信息

1. Server 默认填写：https://postcat.com/api， 用户无需修改
2. Token获取
3. 3. WorkspaceID 和 ProjectID 获取

1.  

    

   4. StringType 决定出入参的字符串类型，只有参数名一开始就是遵守驼峰规范才会发现改变，预览窗口可看到变化结果

2. 注意事项

1. 进行解析上传前，请确保 IDEA 在项目中已经构建完，相关依赖已经下载好。
2. 强烈推荐使用插件定义的注释，插件有强大的生成注释功能，强烈建议先生成插件的注释进行编辑再上传，注释可以在设置也进行自定义。
3. 在识别不到插件注释时，仅对 Spring MVC、 Swagger.v2和 Swagger(OpenAPI).v3的注解只做部分简单支持。为避免必要参数的缺失，推荐使用插件注释。
4. 生成注释功能会对 Spring MVC、 Swagger.v2 和 Swagger(OpenAPI).v3的注解只做部分简单支持，而不会让你重头编写。
5. HTTP接口通过路由和请求方式判断唯一做覆盖更新处理
6. 对于已经上传的 API，在 web 上进行过手动修改，不建议再使用上传功能，因为插件上传会覆盖掉之前的内容。
7. 在生成/手敲了插件javadoc后，对接口uri，请求方式（GET/POST）等做了修改，需要手动修改插件javadoc，否则插件还是会识别到旧的插件javadoc信息。
8. 自动生成的类注释默认会上传到 默认分组，请用户自行填写真实的分组，分组通过名字识别。
   1. 如多级分组，则用 .隔开，比如需要把接口传到 第三方分组下的 用户分组，则 group-name 填写 第三方.用户。
9. @group-name注释 支持到方法级别，默认不生成，可手动添加到方法注释，插件会帮你将当前方法存到对应分组中。
10. 项目级别的 api 扫描和上传，顶部菜单 [Tools -> Upload Project Api Doc]，具体使用规则看 项目级上传。
11. 生成类注释不在默认生成 @required注释，只会针对有 javax.validation.constraints.NotNull注解的字段才生成。
12. 不推荐使用 @remark注释，插件保留了识别功能且将内容拼接到字段说明中，生成类注释不会自动生成。
13. 通过 @PathVariable，POST方法默认把参数识别成 Formdata 类型，GET方法默认把参数识别成 query 类型。
14. //标识的注释无法被识别出来，请使用 /** */标识。