IDEA
In this section, you will learn how to install and use the Apidog Helper plugin for IntelliJ IDEA.
Apidog Helper is a plugin launched by Apidog for the IntelliJ IDEA. It can parse the source code of Java or Kotlin projects, automatically generate API specifications and sync them to Apidog projects.
By analyzing Java/Kotlin annotations and Javadoc/KDoc comments, the plugin can generate a detailed and well-structured API specification.
Supported frameworks and libraries:
| Type | Name | Annotation Examples |
|---|---|---|
| Web Framework | • Spring • Jakarta RESTful Web Services (JAX-RS) | @RestController, @GetMapping @Path, @Get |
| Validation | • Jakarta Bean Validation • Java Bean Validation | @NotNull |
| Serialization | • Jackson • GSON | @JsonProperty @SerializedName |
| API Specification Library | • Swagger 2.x • Swagger/OpenAPI 3.x | @ApiOperation, @ApiParam |
| Persistence | MyBatis | |
| Client | Spring Cloud OpenFeign | |
| Monitor | • Spring Boot Actuator | |
| Language and Comments | • Java: Javadoc • Kotlin: KDoc |
This plugin is customized and developed based on easy-api, thanks to the author of easy-api.
1. Installation
Search for Apidog Helper in the plugin Marketplace of IntelliJ IDEA and install it.
The plugin supports IntelliJ IDEA 2019.3 and higher versions.
2. Generate API Access Token
Before using the Apidog Helper plugin, you need to register an Apidog account and generate the corresponding API access token. For detailed instructions, please refer to Generate API Access Token.
In Apidog Helper, fill in your API access token, and then click "Test Token". If the test is successful, click "Apply" or "OK" button, and then use Apidog Helper normally.
3. Upload APIs
Support uploading APIs within the following scope:
- All APIs in the module: Right-click on the module node in the left directory tree and select "Upload to Apidog"
- All APIs in the Controller: Inside the Controller file, right-click and select "Upload to Apidog"
If this is your first time to uploading to Apidog, a pop-up will appear asking you to select the target project. You can select either a project or a folder within the project. Selecting the project will upload the APIs to the project's root folder.
Schemas do not need to be configured. The API specification will be uploaded to the schema root folder of the project where the APIs are located by default.
4. View API Documentation
After the upload is complete, open Apidog and click the refresh button in the top right corner. This will allow you to see the API specification generated from your Java or Kotlin source code.
Afterward, you can easily share the API documentation, allowing others to conveniently view it in a browser. For detailed instructions, please refer to Shared Docs.
Privacy and Security Statement
The Apidog Helper plugin only runs the detection of Java and Kotlin source code on your local machine. At Apidog, we prioritize the security of your data assets, ensuring that your Java and Kotlin source code will never be uploaded to the Apidog server.
Contact Us
If you encounter any issues or have feedback while using the Apidog Helper plugin, please reach us at support@apidog.com or join our Discord community.