PathParam

A PathParam is a parameter that is part of the Uniform Resource Identifier (URI) of a web resource. These parameters are embedded directly within the path of the URL, as opposed to being appended as query parameters after a question mark. For example, in the URL `/users/123/orders/456`, `123` and `456` are path parameters representing a user ID and an order ID, respectively.

PathParam values are typically extracted by a web framework or a routing mechanism on the server-side. This extraction is usually based on defined patterns or templates that match parts of the incoming URL. The extracted values are then made available to the application's code, often as arguments to a controller or handler function.

The primary use of PathParams is to identify specific resources. They are crucial for creating RESTful APIs where URLs are designed to represent resources and their relationships. By using PathParams, developers can create clear, hierarchical, and human-readable URLs that effectively communicate the nature of the resource being accessed. This contrasts with query parameters, which are more commonly used for filtering, sorting, or pagination of resource collections. When designing APIs, PathParams are generally reserved for unique identifiers of individual resources.

---