Uploaded image for project: 'YesCart'
  1. YesCart
  2. YC-993

Rename REST API endpoints to conform to best practices

    Details

    • Type: Story
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.7.0, 3.7.0.E
    • Component/s: None
    • Labels:
      None

      Description

      As a developer I would like REST API to follow best practices.

      • Use of plural form for resources (e.g. /orders/111 and opposed to /order/111)
      • Consistent use of methods:
        • GET retrieves a representation of the resource at the specified URI. The body of the response message contains the details of the requested resource.
        • POST creates a new resource at the specified URI. The body of the request message provides the details of the new resource. Note that POST can also be used to trigger operations that don't actually create resources.
        • PUT either creates or replaces the resource at the specified URI. The body of the request message specifies the resource to be created or updated.
        • PATCH performs a partial update of a resource. The request body specifies the set of changes to apply to the resource.
        • DELETE removes the resource at the specified URI.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                InspireSoftware InspireSoftware
                Reporter:
                InspireSoftware InspireSoftware
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: