网站导航
> 文章列表 > Postcat IDEA 插件，最全的使用教程

Postcat IDEA 插件，最全的使用教程

网友: 文章列表 2024-03-22 00:37:08

Postcat IDEA 插件，最全的使用教程

 

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

下面说一说，这个插件如何使用，是时候展现真正的技术了~

如何安装配置？

IDEA 版本需大于 IntelliJ IDEA 2022.03

在 IDEA “设置-插件-Marketplace” 中搜索 Postcat，找到 Postcat 插件安装即可。同时也可在IDEA插件市场上进行下载安装，本地的IDEA没有自动唤起时，可以直接把zip包拖入IDEA中即可完成安装/更新。

填写配置信息

首次上传需要填写配置信息，配置信息项目之间独立。

配置信息获取途径：登陆 Postcat 进入项目中获取 Token、WorkspaceID 和 ProjectID。

  1. Server 默认填写：https://postcat.com/api， 用户无需修改

  2. Token获取

     

  3. WorkspaceID 和 ProjectID 获取

     

    1. 进入项目设置页面，点击项目名右侧“问号”

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

1. 当参数名为userInfo，选择 camelCase，依旧是userInfo，这是默认选项

2. 当参数名为userInfo，选择 lower_underscore，会变成user_info

3. 当参数名为userInfo，选择 UPPER_UNDERSCORE，会变成USER_INFO

注意事项

  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. //标识的注释无法被识别出来，请使用/** */标识。

这款插件通过分析用户注释进行接口解析，最终生成接口文档并上传至 Postcat 服务器，使得开发者可以在 Postcat 上进行 API 管理和分享，提高协作能力和开发速度。

Postcat 提供了多种拓展注释，如@path、@url、@method、@name、@hidden和@required，这些注释可以在设置界面进行自定义或兼容现有注释。

此外，Postcat 还提供了注释生成功能，对于没有或仅有少量注释的类和方法，开发者无需费力手动添加，该功能可以分析方法字段含义并自动生成注释。开发者只需要检查或根据实际场景进行微调，即可生成一份较完善的API文档。

如果原有注释不足，Postcat 会通过添加方式补充注释，移除注释时只会移除Postcat提供的那些拓展性注释，不会破坏用户自身的注释。同时，开发者还可以使用"意图"功能局部生成插件注释，并进行调整和修改。

Postcat提供了多种 API 上传方式，方便开发者在不同的场景下使用。

关于 Postcat

Postcat 是一个强大的开源、跨平台（Windows、Mac、Linux、Browsers...）的 API 开发测试工具，支持 REST、Websocket 等协议（即将支持 GraphQL、gRPC、TCP、UDP），帮助你加速完成 API 开发和测试工作。

好了，如果你对这个插件感兴趣，不妨去市场搜一搜，觉得项目还不错的话，不妨去Github Star 支持一波！

Github ：

https://github.com/Postcatlab/postcat

网络标签：

相关问题