OpenApiHelper is a personal plugin project for IntelliJ IDEA, designed to improve navigation, usability, and refactoring workflows when working with OpenAPI specifications. The primary goal is to align the plugin functionality with my specific development needs and workflows. While the features may not suit everyone's preferences, feel free to fork the repository and tailor it to your own use!
The following are features I aim to implement as part of this project. These features are primarily focused on enhancing navigation and refactoring capabilities for OpenAPI-based projects:
-
Navigate from Endpoint Definitions to Implementations
- Support for spring-kotlin generator to quickly move from defined operations (e.g.,
registerUser) in OpenAPI specifications to the actual implementation in your codebase.
- Support for spring-kotlin generator to quickly move from defined operations (e.g.,
-
Show Endpoint Usages
- Track and display usage of endpoints in Kotlin and TypeScript clients. This will help trace where and how specific endpoints are being utilized in your codebase.
-
Navigation from Schema Components to Generated Classes
- Click on a component schema definition in your OpenAPI specification to directly jump to the corresponding generated class.
-
Navigation from Generated Classes to Schema Components
- Click on a generated class to directly jump to the corresponding schema definition in your OpenAPI specification.
- Personal Project: This plugin is a personal initiative developed in my free time. As such, I focus on implementing features that solve problems I encounter in my everyday workflow.
- Community Contributions: While the plugin is tailored to my needs, I encourage you to fork the repository and extend it to fit your specific requirements.
- Head to the Releases Page
- Download the latest
.zipfile of the plugin. - Open IntelliJ IDEA.
- Navigate to
Preferences>Plugins>Install Plugin from Disk.... - Select the downloaded
.zipfile and install. - Restart IntelliJ IDEA to activate the plugin.
Below is a tentative roadmap for feature implementation:
- Initial setup and basic navigation capabilities.
- Full support for navigating from endpoint definitions to implementations.
- Endpoint usage tracking for Kotlin and TypeScript.
- Support for navigating from generated classes to schema components.
- Component schema navigation to generated classes.
Contributions are welcome! If you'd like to contribute:
- Fork the repository.
- Clone and create a new branch for your feature or bug fix.
- Make your changes and submit a pull request describing your updates.
This plugin is licensed under the MIT license. Feel free to use, modify, and distribute the plugin as per the license terms.
Thank you for checking out OpenApiHelper! If you have any questions, issues, or suggestions, feel free to reach out or create an issue on GitHub.