Module vibe.web.common
Contains common functionality for the REST and WEB interface generators.
Functions
Name | Description |
---|---|
adjustMethodStyle
|
Adjusts the naming convention for a given function name to the specified style .
|
bodyParam
|
Declare that a parameter will be transmitted to the API through the body. |
contentType
|
Attribute to define the content type for methods. |
extractHTTPMethodAndName
|
Determines the HTTP method and path for a given function symbol.
|
headerParam
|
Declare that a parameter will be transmitted to the API through the headers. |
method
|
Attribute to force a specific HTTP method for an interface method .
|
path
|
Attibute to force a specific URL path .
|
queryParam
|
Declare that a parameter will be transmitted to the API through the query string. |
rootPath
|
Deprecated - use @path instead.
|
rootPathFromName
|
Convenience alias to generate a name from the interface's name. |
Classes
Name | Description |
---|---|
RestException
|
Respresents a Rest error response |
Enums
Name | Description |
---|---|
MethodStyle
|
Determines the naming convention of an identifier. |
Authors
Sönke Ludwig, Михаил Страшун
Copyright
© 2012-2014 RejectedSoftware e.K.
License
Subject to the terms of the MIT license, as written in the included LICENSE.txt file.