Guidelines for REST URI naming conventions
- Last Updated: January 16, 2024
- 1 minute read
- OpenEdge
- Version 12.8
- Documentation
When you determine naming conventions for REST service URIs, follow these guidelines:
- URIs are case-sensitive.
- The name must start with “/”. For example,
/Customers/{custId}. - In a REST resource URI, do not use Java-reserved words such as int, char, or Boolean as the path or query parameter name.
- The resource name in the URI must represent the resource being operated on in the application. For example, suppose you add a resource for the Read method in Customer.cls. Since it is a customer record that is being operated on, the service relative URI should be /Customers (not /readcustomer or /read1).