Interface IEndpoint

HTTP method of the API operation.

IMPORTANT: Methods must be written in lowercase only (e.g., "get", not "GET").

Note that, if the API operation has requestBody, method must not be get.

Also, even though the API operation has been designed to only get information, but it needs complicated request information, it must be defined as patch method with requestBody data specification.

• get: get information
• patch: get information with complicated request data (requestBody)
• post: create new record
• put: update existing record
• delete: remove record

HTTP path of the API operation.

The URL path for accessing this API operation, using path parameters enclosed in curly braces (e.g., /shoppings/customers/sales/{saleId}).

It must be corresponded to the parameters path parameters.

The path structure should clearly indicate which database entity this operation is manipulating, helping to ensure all entities have appropriate API coverage.

Path validation rules:

• Must start with a forward slash (/)
• Can contain only: letters (a-z, A-Z), numbers (0-9), forward slashes (/), curly braces for parameters ({paramName}), hyphens (-), and underscores (_)
• Parameters must be enclosed in curly braces: {paramName}
• Resource names should be in camelCase
• No quotes, spaces, or invalid special characters allowed
• No domain or role-based prefixes

Valid examples:

• "/users"
• "/users/{userId}"
• "/articles/{articleId}/comments"
• "/attachmentFiles"
• "/orders/{orderId}/items/{itemId}"

Invalid examples:

• "'/users'" (contains quotes)
• "/user profile" (contains space)
• "/users/[userId]" (wrong bracket format)
• "/admin/users" (role prefix)
• "/api/v1/users" (API prefix)