- is an IDEA plugin that supports Java only.
- Generate HTTP interface documentation, which supports markdown and html in format, in order to replace Swagger.
- In theory, all HTTP interfaces developed by Spring MVC annotations are supported, and
Feignmicroservices are also supported. In addition, the pure interface writing method ofDubbois also supported. - At the same time, it comes with some related small capabilities, such as support for exporting to Postman, support for generating cURL commands, support for generating description document tables and json examples for a single data transfer class.
- Ported and improved the functions of two plugins: Github GenerateAllSetter Pull#66 | [Github genSets](https://github.com /yoke233/genSets)
- Modify at any time, generate at any time, no need to start the project
- Support for java doc comments
- Support RPC interface (ie Dubbo/Feign)
- Generated documentation with input/output parameter examples, more intuitive
- A variety of carriers, not limited to web pages or documents; for example, exporting to Postman is currently supported, and subsequent exporting to Yapi, or similar platforms can be easily implemented; our purpose is to write a comment once, and it will work for a lifetime!
- Code always needs some comments, and good memory is not as good as bad writing; and now, there is another good reason to write good comments!
- Every time I write an interface document, I feel like I am doing hard work, especially the management of the background business. It is often the addition, deletion, modification and checking of several tables, which means at least a dozen interfaces. This is completely avoidable!
- This plugin does not only generate interface documents, but also implements more lazy ways (as long as it is related to interfaces), and there are many more waiting for us to discover!
Download the zip package from the latest Release page, then open IDEA, go to Settings --> Plugins --> Pinion --> Install Plugin from Disk
Open IDEA, go to Settings --> Plugins, select Marketplace, enter api savior and click Install
It is recommended to open the example project I specially prepared: api-savior-examples
git clone https://github.com/gudqs7-idea-plugins/api-savior-examplesFind a Controller or RPC interface class,
Such as cn.gudqs.example.docer.restful.user.controller.UserController
Right-click on the class name and click Generate Api Interface Doc
The document is as follows
Right-click directly on the project (or a directory/a class/any multi-selection), and then click the corresponding button, as shown below
Suppose I click Batch Generate Api Interface Doc, I will get a folder, the Markdown interface document of the molecule folder by module (can be customized, the default is the last two levels of registration), as shown below
Double-click Shift to enter Search Everywhere and switch to Api, or use the shortcut keys Ctrl + \ or Ctrl + Alt + N to enter the interface as shown below.
At this point you can search and jump to the interface by url or interface description.
For this purpose, I opened a separate project search-everywhere-api-idea-plugin, welcome to Star!
Everyone is welcome to ask questions, and everyone is welcome to improve it together!
In addition, I have connected to the error handling component of IDEA, so when I find an error message from the plugin, follow the IDEA prompt to view the error information and report it to me with one click (that is, an issue is automatically generated)
- Click to view the HTML format document effect of the example project
- Click to visit the example project Github
- Github intellij-generateAllSetMethod
- Github genSets
- Github RESTKit
- Thanks to JetBrains OpenSource for the full product license for this project!
