vibe.d beta banner
get vibe.d
0.8.1

Asynchronous I/O that doesn’t get in your way, written in D

Struct RestInterface

Provides all necessary tools to implement an automated REST interface.

struct RestInterface(TImpl)
  
if (is(TImpl == class) || is(TImpl == interface));

The given TImpl must be an interface or a class deriving from one.

Constructors

NameDescription
thisFills the struct with information.

Fields

NameTypeDescription
basePathstringFull base path of the interface, including an eventual @path annotation.
baseURLstringFull base URL of the interface, including an eventual @path annotation.
routesRoute[routeCount]Information about each route
settingsRestInterfaceSettingsThe settings used to generate the interface
subInterfacesSubInterface[subInterfaceCount]Information about sub interfaces

Methods

NameDescription
computeRoutes
computeStaticRoutes
computeSubInterfaces
getRoutesGroupedByPatternReturns an array with routes grouped by path pattern

Aliases

NameDescription
AllMethodsAliases to all interface methods
BaseInterfaces
GetAllMethods
GetRouteFunctions
GetSubInterfaceFunctions
GetSubInterfaceTypes
RouteFunctionsAliases for each route method
SubInterfaceFunctionsAliases for each sub interface method
SubInterfaceTypesThe 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.