Struct RestInterface
Provides all necessary tools to implement an automated REST interface.
The given TImpl
must be an interface
or a class
deriving from one.
Constructors
Name | Description |
---|---|
this
|
Fills the struct with information. |
Fields
Name | Type | Description |
---|---|---|
basePath
|
string |
Full base path of the interface, including an eventual @path annotation.
|
baseURL
|
string |
Full base URL of the interface, including an eventual @path annotation.
|
routes
|
Route[routeCount] |
Information about each route |
settings
|
RestInterfaceSettings |
The settings used to generate the interface
|
subInterfaces
|
SubInterface[subInterfaceCount] |
Information about sub interfaces |
Methods
Name | Description |
---|---|
computeDefaultPath
|
|
computeRoutes
|
|
computeStaticRoutes
|
|
computeSubInterfaces
|
|
getRoutesGroupedByPattern
|
Returns an array with routes grouped by path pattern
|
Aliases
Name | Description |
---|---|
AllMethods
|
Aliases to all interface methods |
BaseInterfaces
|
|
GetAllMethods
|
|
GetRouteFunctions
|
|
GetSubInterfaceFunctions
|
|
GetSubInterfaceTypes
|
|
RouteFunctions
|
Aliases for each route method |
SubInterfaceFunctions
|
Aliases for each sub interface method |
SubInterfaceTypes
|
The type of each sub interface |
Authors
Sönke Ludwig
Copyright
© 2015 RejectedSoftware e.K.
License
Subject to the terms of the MIT license, as written in the included LICENSE.txt file.