This is an automated email from the ASF dual-hosted git repository.
deepak pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git
The following commit(s) were added to refs/heads/trunk by this push:
new 2305d8173 Added example.rest.xml to demonstrate rest-api capability
2305d8173 is described below
commit 2305d817333e1e9715830f5c47c21c0bb9246892
Author: Deepak Dixit <[email protected]>
AuthorDate: Thu Aug 21 11:10:51 2025 +0530
Added example.rest.xml to demonstrate rest-api capability
- Introduced example.rest.xml showing how to define REST endpoints
- Defining endpoints in rest.xml gives better control over exposed APIs
- Helps segregate REST endpoints by functionality
- For now, rest.xml should be located in the folder as
componentName.rest.xml
- Future enhancement: allow multiple rest.xml files per component
---
example/api/example.rest.xml | 46 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 46 insertions(+)
diff --git a/example/api/example.rest.xml b/example/api/example.rest.xml
new file mode 100644
index 000000000..69dfba7dc
--- /dev/null
+++ b/example/api/example.rest.xml
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<api name="ExampleRestApi"
+ displayName="Example REST API"
+ description="This API exposes example services as REST endpoints."
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+
xsi:noNamespaceSchemaLocation="https://ofbiz.apache.org/dtds/rest-api.xsd";>
+
+ <resource name="ExampleResource"
+ path="/example"
+ displayName="Example Resource"
+ description="Handles example-related operations">
+
+ <operation verb="post" description="Create Example"
+ consumes="application/json">
+ <service name="createExample"/>
+ </operation>
+
+ <operation verb="delete" description="delete Example"
+ consumes="application/json">
+ <service name="deleteExample"/>
+ </operation>
+ <operation verb="put" description="Update Example"
+ consumes="application/json">
+ <service name="updateExample"/>
+ </operation>
+ </resource>
+</api>
\ No newline at end of file
