当有接口对接需求的时候,开发终于不用再担心 API 文档难写了,也不用再一个个接口文档重新写!安装这个 IDEA 插件,可以一步将文档导入到 Postcat。
这款插件操作简单,容易上手,能够让开发者省去API文档编写的工作,更专注于开发。插件通过分析用户注释进行接口解析,最终生成接口文档并上传至 Postcat 服务器,使得开发者可以在 Postcat 上进行 API 管理和分享,提高协作能力和开发速度。
Postcat 插件不会入侵到代码内部,无需添加任何jar包依赖
插件通过分析用户注释进行接口解析,最终生成接口文档并上传至 Postcat 服务器,使得开发者可以在 Postcat 上进行 API 管理和分享,提高协作能力和开发速度。
Postcat 提供了多种拓展注释,如@path
、@url
、@method
、@name
、@hidden
和@required
,这些注释可以在设置界面进行自定义或兼容现有注释。
此外,Postcat 还提供了注释生成功能,对于没有或仅有少量注释的类和方法,开发者无需费力手动添加,该功能可以分析方法字段含义并自动生成注释。开发者只需要检查或根据实际场景进行微调,即可生成一份较完善的API文档。
如果原有注释不足,Postcat 会通过添加方式补充注释,移除注释时只会移除Postcat提供的那些拓展性注释,不会破坏用户自身的注释。同时,开发者还可以使用"意图"功能局部生成插件注释,并进行调整和修改。
Postcat提供了多种 API 上传方式,方便开发者在不同的场景下使用:
Tools
分组下的Upload Project Api Doc
来完成项目级别的接口上传。Upload All Api
来进行单个文件级别全部上传,做到先有文档再有逻辑,前后端工作不再串行阻塞。Upload Api
功能,该功能会展示当前编辑类的接口信息,并提供接口预览和接口选择界面,使得用户可以勾选需要更新或上传的目标API进行信息核对和上传。IDEA 版本需大于 IntelliJ IDEA 2022.03
在 IDEA “设置-插件-Marketplace” 中搜索 Postcat
,找到 Postcat
插件安装即可。同时也可在IDEA插件市场上进行下载安装,本地的IDEA没有自动唤起时,可以直接把zip包拖入IDEA中即可完成安装/更新。
首次上传需要填写配置信息,配置信息项目之间独立。
配置信息获取途径:登陆 Postcat 进入项目中获取 Token、WorkspaceID 和 ProjectID。
3. WorkspaceID 和 ProjectID 获取
4. StringType 决定出入参的字符串类型,只有参数名一开始就是遵守驼峰规范才会发现改变,预览窗口可看到变化结果
1. 当参数名为userInfo
,选择 camelCase,依旧是userInfo
,这是默认选项
2. 当参数名为userInfo
,选择 lower_underscore,会变成user_info
3. 当参数名为userInfo
,选择 UPPER_UNDERSCORE,会变成USER_INFO
Spring MVC
、Swagger.v2
和Swagger(OpenAPI).v3
的注解只做部分简单支持。为避免必要参数的缺失,推荐使用插件注释。Spring MVC
、Swagger.v2
和Swagger(OpenAPI).v3
的注解只做部分简单支持,而不会让你重头编写。HTTP
接口通过路由和请求方式判断唯一做覆盖更新处理默认分组
,请用户自行填写真实的分组,分组通过名字识别。
.
隔开,比如需要把接口传到第三方
分组下的用户
分组,则 group-name 填写 第三方.用户。@group-name
注释 支持到方法级别,默认不生成,可手动添加到方法注释,插件会帮你将当前方法存到对应分组中。[Tools -> Upload Project Api Doc]
,具体使用规则看 项目级上传
。@required
注释,只会针对有javax.validation.constraints.NotNull
注解的字段才生成。@remark
注释,插件保留了识别功能且将内容拼接到字段说明中,生成类注释不会自动生成。@PathVariable
,POST方法默认把参数识别成 Formdata 类型,GET方法默认把参数识别成 query 类型。//
标识的注释无法被识别出来,请使用/** */
标识。 Postcat 是一个强大的开源、跨平台(Windows、Mac、Linux、Browsers...)的 API 开发测试工具,支持 REST、Websocket 等协议(即将支持 GraphQL、gRPC、TCP、UDP),帮助你加速完成 API 开发和测试工作。
在使用过程中有任何疑问,可以进群交流:
也可以在线提 Issue(强烈推荐这种开源的方式),提问题本身就已经在贡献社区了: https://github.com/Postcatlab/postcat/issues
这个项目是开源的,如果你觉得这个项目还不错的话,不妨点个 Star 支持一下!
Github :https://github.com/Postcatlab/postcat
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。