hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-29 17:57:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

spring_api.md: fix up

Browse Source
This commit is contained in:
Yann Cébron 2021-12-16 10:54:06 +01:00
parent ab8308eb2e
commit 8d70e07df8
1 changed files with 6 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
topics/products/idea/spring_api.md
View File

@ -12,11 +12,11 @@ To develop plugins, you will need to use _IntelliJ IDEA Ultimate Edition_ versio
Setup [Gradle build script](gradle_guide.md#intellij-platform-configuration) to target IntelliJ IDEA Ultimate, then [add dependency](plugin_dependencies.md) to bundled Spring plugin with ID `com.intellij.spring`. Setup [Gradle build script](gradle_guide.md#intellij-platform-configuration) to target IntelliJ IDEA Ultimate, then [add dependency](plugin_dependencies.md) to bundled Spring plugin with ID `com.intellij.spring`.
Please use only Spring-related functionality exposed in `spring-api.jar` (where sources are provided) in your plugin. Please use only Spring-related functionality exposed in <path>spring-api.jar</path> (sources are provided in <path>$IDEA_HOME$/lib/src/src_spring-boot-openapi.zip</path>) in your plugin.
Using any other "internal" (implementation) classes from Spring plugin itself (`spring.jar`) is _not_ supported. Using any other "internal" (implementation) classes from Spring plugin itself (<path>spring.jar</path>) is _not_ supported.
### plugin.xml ### plugin.xml
Add `<depends>com.intellij.spring</depends>` to your `plugin.xml` to require "Spring Support" plugin to be activated. Add `<depends>com.intellij.spring</depends>` to your <path>plugin.xml</path> to require "Spring Support" plugin to be activated.
All available extension points are provided under `com.intellij.spring` prefix. All available extension points are provided under `com.intellij.spring` prefix.
Note that the "Spring Support" plugin itself has dependencies on a few other plugins which need to be enabled in your sandbox (see notifications on startup). Note that the "Spring Support" plugin itself has dependencies on a few other plugins which need to be enabled in your sandbox (see notifications on startup).
@ -167,17 +167,11 @@ Spring Boot API allows extending/accessing Spring Boot specific support in the I
{type="warning"} {type="warning"}
### Setting up ### Setting up
Please perform these steps _additionally_ to setting up Spring API support (see [here](#setting-up-intellij-platform-sdk)): [Add dependency](plugin_dependencies.md) to bundled Spring Boot plugin with ID `com.intellij.spring.boot`.
Sources for Spring Boot API are available in <path>$IDEA_HOME$/lib/src/src_spring-boot-openapi.zip</path>.
* add to _classpath_ (_not_ to your plugin module's dependencies)
* `$IDEA_HOME$/plugins/SpringBoot/lib/spring-boot.jar`
* `$IDEA_HOME$/plugins/SpringBoot/lib/spring-boot-initializr.jar` (optional)
* `$IDEA_HOME$/plugins/SpringBoot/lib/spring-boot-run.jar` (optional)
* add to _sourcepath_
* `$IDEA_HOME$/lib/src/src_spring-boot-openapi.zip`
### Update plugin.xml ### Update plugin.xml
Add `<depends>com.intellij.spring.boot</depends>` to your `plugin.xml` to require "Spring Boot" plugin to be activated. Add `<depends>com.intellij.spring.boot</depends>` to your <path>plugin.xml</path> to require "Spring Boot" plugin to be activated.
All available extension points are provided under `com.intellij.spring.boot` prefix. All available extension points are provided under `com.intellij.spring.boot` prefix.
### Spring Boot Library ### Spring Boot Library
@ -192,12 +186,8 @@ Existing `Condition` implementations can be simulated at design time in IDE via
Custom `@ConditionalOn...` annotations implementing `com.intellij.spring.boot.model.autoconfigure.conditions.jam.ConditionalOnJamElement` will be added into evaluation automatically. Custom `@ConditionalOn...` annotations implementing `com.intellij.spring.boot.model.autoconfigure.conditions.jam.ConditionalOnJamElement` will be added into evaluation automatically.
### Spring Initializr ### Spring Initializr
requires `spring-boot-initializr.jar`
`com.intellij.spring.boot.initializr.SpringInitializrModuleBuilderPostTask` allows performing custom setup steps after creation of module (e.g. setup integration with build system). `com.intellij.spring.boot.initializr.SpringInitializrModuleBuilderPostTask` allows performing custom setup steps after creation of module (e.g. setup integration with build system).
### Endpoint Tab ### Endpoint Tab
_2018.2_ - requires `spring-boot-run.jar`
Use EP `com.intellij.spring.boot.run.endpoint` to add custom actuator endpoint tabs. Use EP `com.intellij.spring.boot.run.endpoint` to add custom actuator endpoint tabs.
Any settings should be exposed in "Spring Boot" settings tab via `com.intellij.spring.boot.run.endpointTabConfigurable` EP. Any settings should be exposed in "Spring Boot" settings tab via `com.intellij.spring.boot.run.endpointTabConfigurable` EP.