Improve documentation: Migrate XML snippets to yaml javadoc (#2768)

* Update LoadBalancingInterceptor documentation

* Update SetCookiesInterceptor documentation with YAML example

* Add YAML example to WSDLPublisherInterceptor documentation

* Add YAML example to Cluster documentation

* Add YAML example to BeautifierInterceptor documentation

* Add YAML example to JavascriptInterceptor documentation

Author: christiangoerdes

core/src/main/java/com/predic8/membrane/core/interceptor/balancer/Cluster.java

@@ -24,6 +24,18 @@
 /**
  * @description Represents a load-balancing cluster (a named group of {@link Node}s).
  * Provides status management (UP/DOWN/TAKEOUT), node lookup, and simple session tracking.
+ * @yaml <pre><code>
+ * balancer:
+ *   name: DemoBalancer
+ *   priorityStrategy: {}
+ *   clusters:
+ *     - name: PROD
+ *     	 nodes:
+ *         - host: node1.predic8.com
+ *       	 port: 8080
+ *         - host: node2.predic8.com
+ *           port: 8090
+ * </code></pre>
  */
 @MCElement(name="cluster", component =false)
 public class Cluster {

core/src/main/java/com/predic8/membrane/core/interceptor/balancer/LoadBalancingInterceptor.java

@@ -43,15 +43,12 @@
  *         name: DemoBalancer
  *         priorityStrategy: {}
  *         clusters:
- *           - cluster:
- *               name: PROD
- *               nodes:
- *                 - node:
- *                     host: node1.predic8.com
- *                     port: 8080
- *                 - node:
- *                     host: node2.predic8.com
- *                     port: 8090
+ *           - name: PROD
+ *             nodes:
+ *               - host: node1.predic8.com
+ *                 port: 8080
+ *               - host: node2.predic8.com
+ *                 port: 8090
  * </code></pre>
  */
 @MCElement(name = "balancer")

core/src/main/java/com/predic8/membrane/core/interceptor/beautifier/BeautifierInterceptor.java

@@ -29,6 +29,16 @@
 
 /**
  * @description Beautifies request and response bodies. Supported are the Formats: <b>JSON</b>, <b>JSON5</b>, <b>XML</b>, <b>TEXT</b>
+ * @yaml <pre><code>
+ * api:
+ *   port: 2000
+ *   flow:
+ *     - static:
+ *         contentType: application/json
+ *         src: <foo><bar>baz</bar></foo>
+ *     - beautifier: {}
+ *     - return: {}
+ * </code></pre>
  * @topic 2. Enterprise Integration Patterns
  */
 @MCElement(name = "beautifier")

core/src/main/java/com/predic8/membrane/core/interceptor/javascript/JavascriptInterceptor.java

@@ -27,6 +27,21 @@
 /**
  * @description Executes a Javascript. The script can access and manipulate data from the request and response.
  * Use this or the Groovy plugin to extend the functions of Membrane by scripting. See the samples in examples/javascript.
+ * @yaml <pre><code>
+ * api:
+ *   port: 2000
+ *   flow:
+ *     - response:
+ *         - javascript:
+ *             src: |
+ *               var body = JSON.stringify({
+ *               foo: 7,
+ *               bar: 42
+ *               });
+ *
+ *               Response.ok(body).contentType("application/json").build();
+ *     - return: {} # Do not forward, return immediately
+ * </code></pre>
  * @topic 2. Enterprise Integration Patterns
  */
 @MCElement(name = "javascript", mixed = true)

core/src/main/java/com/predic8/membrane/core/interceptor/lang/SetCookiesInterceptor.java

@@ -32,6 +32,15 @@
  * @description Adds one or more Set-Cookie headers to the HTTP response for session handling, user preferences, or tracking purposes.
  *              Supports computing expiry, setting standard attributes like Domain and Path, and building a compliant cookie string.
  *              Useful for enriching responses with configurable cookies directly at gateway level without backend involvement.
+ * @yaml <pre><code>
+ * api:
+ *   port: 2000
+ *   flow:
+ *     - response:
+ *         - setCookies:
+ *             - name: SESSION
+ *               value: akj34
+ * </code></pre>
  * @topic 6. Misc
  */
 @MCElement(name = "setCookies", noEnvelope = true)

core/src/main/java/com/predic8/membrane/core/interceptor/server/WSDLPublisherInterceptor.java

@@ -37,6 +37,19 @@
  * The <i>wsdlPublisher</i> serves WSDL files (and attached XML Schema Documents), if your
  * backend service does not already do so.
  * </p>
+ * @yaml <pre><code>
+ * api:
+ *   port: 2000
+ *   path:
+ *     uri: /material/*
+ *   flow:
+ *     - wsdlPublisher:
+ *         wsdl: /WEB-INF/wsdl/ArticleService.wsdl
+ *     - validator:
+ *         wsdl: /WEB-INF/wsdl/ArticleService.wsdl
+ *   target:
+ *     url: https://api.predic8.de
+ * </code></pre>
  * @topic 5. Web Services with SOAP and WSDL
  */
 @MCElement(name = "wsdlPublisher")