You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration/configuration.md
+23Lines changed: 23 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,6 +64,7 @@ The following table contains additional properties that can be specified in the
64
64
|`springwolf.enabled`|`true`| Allows to enable/disable Springwolf at one central place. |
65
65
|`springwolf.init-mode`|`fail_fast`| Springwolf initializes during start up with `fail_fast` or in the `background` after the application has started. |
66
66
|`springwolf.paths.docs`|`/springwolf/docs`| The path of the AsyncAPI document in JSON format. *Note that at the moment the UI will work only with the default value.*|
67
+
|`springwolf.endpoint.actuator.enabled`|`false`| Publish the AsyncAPI document as part of Spring Boot’s actuator feature. |
67
68
|`springwolf.scanner.consumer-data.enabled`|`true`| Enable scanner to find consumers defined in `AsyncApiDocket`. |
68
69
|`springwolf.scanner.producer-data.enabled`|`true`| Enable scanner to find producers defined in `AsyncApiDocket`. |
69
70
|`springwolf.scanner.async-listener.enabled`|`true`| Enable scanner to find methods annotated with `@AsyncListener`. |
@@ -81,6 +82,28 @@ The following table contains additional properties that can be specified in the
81
82
82
83
83
84
85
+
## Actuator support
86
+
87
+
Springwolf supports exposing the AsyncAPI document as part of Spring Boot’s actuator endpoint.
88
+
The AsyncAPI document will then be moved underneath actuators base path, that's `/actuator/springwolf/docs.json` or `/actuator/springwolf/docs.yaml` respectively.
89
+
90
+
To enable it, add the `spring-boot-actuator` dependency first.
91
+
Second, enable the actuator endpoint in the `application.properties` file:
0 commit comments