Yapi X

本项目已收录到YApi, Rap2官方仓库

一键生成API接口文档, 上传到YApi, Rap2, Eolinker等平台的IDEA插件.

亮点

• 零成本、零入侵： 编写标准Javadoc即可，无需依赖swagger注解, 生成文档准确性高达99%。
• 开箱即用、智能mock规则: 几乎零配置直接可生成文档，也支持复杂配置满足你95%的场景。
• 多平台支持：支持YApi, Rap2, Eolinker等，并支持账户密码登录。

特性

• 一键从源代码生成api文档
• 上传到YApi平台
• 上传到Rap2平台
• 上传到Eolinker平台
• 上传到ShowDoc平台
• 导出markdown文件
• 复制为cURL命令

使用

1. 安装: 打开Idea -> File -> Settings -> Plugins, 搜索: Yapi X
2. 配置: 项目根目录创建".yapix"文件, 内容: yapiProjectId=110
3. 上传: 光标放置在你的控制类或方法，右键执行: Upload To YApi ( 提示：如果未填登录信息，会弹窗提示 )

更多：十分钟使用指南

交流

欢迎提出您的发现问题、需求、建议、以及提交代码来参与贡献。

• QQ交流群：860701800

提示：如果您准备为该插件开发一个新功能，请先通过issues讨论，避免重复开发。

捐赠

非常感谢您使用Yapi X，如果贵公司有非通用的定制开发需求，可提供有偿定制开发服务。