node
node copied to clipboard
Inconsistent REST API pattern
The below set of endpoints break the REST Resource Naming Best Practices and are inconsistent with the rest of the endpoints that follow correct practices.
-
/deployment
-
/market/order
-
/provider
A resource should be a singleton or a collection. For example, “deployments” is a collection resource and “deployment” is a singleton resource. We can identify “deployments” collection resource using the URI “/deployments” instead of "deployments/list". We can identify a single “deployment” resource using the URI “/deployment/{deploymentId}” instead of "deployments/info".