vibe.d beta banner
get vibe.d
0.8.4

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
this Fills the struct with information.

Fields

NameTypeDescription
basePath stringFull base path of the interface, including an eventual @path annotation.
baseURL stringFull base URL of the interface, including an eventual @path annotation.
routes Route[routeCount]Information about each route
settings RestInterfaceSettingsThe settings used to generate the interface
subInterfaces SubInterface[subInterfaceCount]Information about sub interfaces

Methods

NameDescription
computeDefaultPath
computeRoutes
computeStaticRoutes
computeSubInterfaces
getRoutesGroupedByPattern Returns an array with routes grouped by path pattern

Aliases

NameDescription
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.