Members
ParamDescription
Description of a parameter decorator.
- Source:
Methods
DELETE()
Publish a method as an http endpoint for DELETE requests. If no Path is specified the path will be /.
The decorator is only allowed on methods.
- Source:
Returns:
the decorated function
GET()
Publish a method as an http endpoint for GET requests. If no Path is specified the path will be /.
The decorator is only allowed on methods.
- Source:
Returns:
the decorated function
HeaderParam(name)
Specifies how a method parameter is evealuated. In this case the value will be taken
from a http header.
Parameters:
Name | Type | Description |
---|---|---|
name |
the name in the http header that should be used to provide the parameter to the method. |
- Source:
Returns:
the decorated function
Path(path)
Specify the Path for teh ressource. If the decorator is present at class level all methods paths will be
prefixed with this path.
Parameters:
Name | Type | Description |
---|---|---|
path |
The path for the class or method. The path must not be start with /. The slash will be added automatically. |
- Source:
Returns:
the decorated function
PathParam(name)
Specifies how a method parameter is evealuated. In this case the value will be taken
from the parameter that is specified in the path decorator.
Parameters:
Name | Type | Description |
---|---|---|
name |
the name in the path that should be used to provide the parameter to the method. |
- Source:
Returns:
the decorated function
POST()
Publish a method as an http endpoint for POST requests. If no Path is specified the path will be /.
The decorator is only allowed on methods.
- Source:
Returns:
the decorated function
PUT()
Publish a method as an http endpoint for PUT requests. If no Path is specified the path will be /.
The decorator is only allowed on methods.
- Source:
Returns:
the decorated function