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.
extractHTTPMethodAndName Uses given function symbol to determine which HTTP method and what URL path should be used to access it in REST API.
method User Defined Attribute interface to force specific HTTP method in REST interface for function in question. Usual URL generation rules are still applied so if there are any "get", "query" or similar prefixes, they are filtered out.
path User Defined Attribute interface to force specific URL path n REST interface for function in question. Path attribute is relative though, not absolute.
rootPath UDA to define root URL prefix for annotated REST interface. Empty path means deducing prefix from interface type name (see also rootPathFromName)
rootPathFromName Convenience alias

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-2013 RejectedSoftware e.K.

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.