{"repo":"gudqs7-idea-plugins/api-savior","free":true,"listed":false,"github":"https://github.com/gudqs7-idea-plugins/api-savior","clone":"git clone https://github.com/gudqs7-idea-plugins/api-savior.git","description":"[IDEA 接口文档插件] 根据代码注释一键生成接口文档, 支持 Restful/Dubbo. 支持 Swagger 注解, 但不止于此","language":"Java","stars":71,"topics":["api","document","intellij-plugin","java","plugin","generate","idea-plugin","idea"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"[release-img]: https://img.shields.io/github/release/gudqs7-idea-plugins/api-savior.svg [latest-release]: https://github.com/gudqs7-idea-plugins/api-savior/releases/latest [plugin-img]: https://img.shields.io/badge/Idea%20Plugin-Api%20Savior-orange.svg [plugin]: https://plugins.jetbrains.com/plugin/16860 [jet-img]: https://img.shields.io/badge/plugin-Install%20Plugin-4597ff.svg [jet]: http://localhost:63342/api/installPlugin?action=install&pluginId=gudqs7.github.io.doc-savior [![GitHub release][release-img]][latest-release] [![Jetbrains Plugins][plugin-img]][plugin] [ ][plugin] [ ][plugin] [![Install Plugins][jet-img]][jet] --- English 🇺🇸 Api Savior 是做什么的？ - 是一个 IDEA 插件，仅支持 Java 。 - 生成 HTTP 接口文档，格式上支持 markdown、html，目的是取代 Swagger。 - 理论上支持所有 Spring MVC 注解开发的 HTTP 接口，同理也支持 Feign 的微服务，另外 Dubbo 这种纯接口写法也是支持的。 - 同时附带一些相关小能力，如支持导出到 Postman，支持生成 cURL 命令，支持单个数据传输类生成说明文档表格、json 示例。 - 移植并完善了两个插件的功能：Github GenerateAllSetter Pull#66 Github genSets 与 Swagger 的区别 - 随时修改，随时生成，无需启动项目 - 支持 java doc 注释 - 支持 RPC 接口（即 Dubbo/Feign） - 生成的文档带有入参/出参示例，更直观 - 多种载体，不局限于网页或文档；比如目前就支持导出到 Postman，后续可以很轻松的实现导出到 Yapi，亦或是类似的平台；我们的目的是，写一次注释，一辈子管用！ 为什么这个项目有用？ 1. 代码总是需要点注释，好记性不如烂笔头；而现在，又多了一个写好注释的好理由！ 2. 每次写接口文档都觉得在做苦力活，尤其是管理后台的业务，动辄就是好几个表的增删改查，也就意味着起码十几个接口，这完全是可避免的！ 3. 这个插件并不是是只能生成接口文档，还可以实现更多的偷懒的方式（只要和接口相关的），还有很多等待着我们去发掘！ 我该如何开始？ 1.安装插件 zip 包安装 从最新的 [Release][latest-release] 页下载 zip 包，然后打开 IDEA，进入 Settings -- Plugins -- 小齿轮 -- Install Plugin from Disk Marketplace 安装 打开 IDEA，进入 Settings -- Plugins，选中 Marketplac","default_branch":null,"files":null,"tree":[],"storefront":"/r/gudqs7-idea-plugins","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/gudqs7-idea-plugins/api-savior/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}