feat(core): Document Springwolf actuator support (#55)

* feat(core): Document Springwolf actuator support * Update configuration.md * feat(core): update actuator property Co-authored-by: Timon Back <[email protected]> --------- Co-authored-by: Timon Back <[email protected]>
springwolf · Sep 29, 2023 · 3043511 · 3043511
1 parent 350accf
commit 3043511
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md
@@ -64,6 +64,7 @@ The following table contains additional properties that can be specified in the
 | `springwolf.enabled`                                     | `true`             | Allows to enable/disable Springwolf at one central place.                                                                 |
 | `springwolf.init-mode`                                   | `fail_fast`        | Springwolf initializes during start up with `fail_fast` or in the `background` after the application has started.         |
 | `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.* |
+| `springwolf.endpoint.actuator.enabled`                   | `false`            | Publish the AsyncAPI document as part of Spring Boot’s actuator feature.                                                  |
 | `springwolf.scanner.consumer-data.enabled`               | `true`             | Enable scanner to find consumers defined in `AsyncApiDocket`.                                                             |
 | `springwolf.scanner.producer-data.enabled`               | `true`             | Enable scanner to find producers defined in `AsyncApiDocket`.                                                             |
 | `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
 
 
 
+## Actuator support
+
+Springwolf supports exposing the AsyncAPI document as part of Spring Boot’s actuator endpoint.
+The AsyncAPI document will then be moved underneath actuators base path, that's `/actuator/springwolf/docs.json` or `/actuator/springwolf/docs.yaml` respectively.
+
+To enable it, add the `spring-boot-actuator` dependency first.
+Second, enable the actuator endpoint in the `application.properties` file:
+```properties
+# Move Springwolf endpoint to actuator
+springwolf.endpoint.actuator.enabled=true
+
+# Expose Springwolf endpoint in spring
+management.endpoints.web.exposure.include=springwolf
+```
+
+If the actuator management port is configured differently than the application port or the actuator base path is changed, then
+the exposed AsyncAPI document will follow accordingly.
+
+:::note
+Enabling actuator support for Springwolf will break the Springwolf UI.
+
+
 [identifier]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#A2SIdString.
 [info]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#infoObject.
 [server]: https://www.asyncapi.com/docs/reference/specification/v2.0.0#serversObject