Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Endpoints and URIs are technology synonymous and are thus used interchangeably. However, it is common for web API documentation to use the term endpoints when endpoint when it only wants to provide URI abbreviationspaths. For instance:

MethodEndpointPurpose

POST

GETPOST/customersCreate a new customer.
GET/customers/{ID}Read a specified customer .
PUT/customers/{ID}Update a specified customer.
DELETE/customers/{ID}Delete a specified customer.

In this format, the host portion of the URI (e.g., www.examples.org) is removed (although likely documented elsewhere) and only the path is referenced (e.g., /customers).GET /api/customers