-
Notifications
You must be signed in to change notification settings - Fork 24
Get Started
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-examples
Find 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.