Class: WaibuRestApi

Constructor

new WaibuRestApi()

Constructor

Source: index.js, line 28

Members

routePath

Generate the route path for a given name.

Source: index.js, line 59

transformResult

Transform the result before sending the response.

Source: index.js, line 79

Methods

(async) _handleError(err, req, reply) → {Object}

Handle general errors.

Parameters:

Name	Type	Description
`err`	Object	The error object
`req`	Object	The request object
`reply`	Object	The reply object

Source: index.js, line 410

Returns:

The transformed result

Type:: Object

(async) _handleNotFound(erropt, req, reply) → {Object}

Handle not found errors.

Parameters:

Name	Type	Attributes	Default	Description
`err`	Object	<optional>	{}	The error object
`req`	Object			The request object
`reply`	Object			The reply object

Source: index.js, line 394

Returns:

The transformed result

Type:: Object

(async) _handleResponse() → {void}

Handle the response.

Source: index.js, line 429

Returns:

Type:: void

(async) _handleSubApp()

Handle sub-applications by collecting and registering their routes.

Source: index.js, line 650

(async) _routeByModelBuilder(options) → {Object}

Build a route based on the model configuration.

Parameters:

Name Type Description

options

Object

The options for building the route

Properties

Name	Type	Attributes	Description
`file`	string		The file path of the model configuration
`dir`	string		The directory of the model configuration
`pathPrefix`	string		The path prefix for the route
`ns`	string		The namespace
`parent`	string	<optional>	The parent namespace

Source: index.js, line 490

Returns:

The built route

Type:: Object

(async) _routeByVerb(options) → {Object}

Build a route based on the HTTP verb.

Parameters:

Name Type Description

options

Object

The options for building the route

Properties

Name	Type	Attributes	Description
`file`	string		The file path of the route configuration
`appCtx`	Object		The application context
`dir`	string		The directory of the route configuration
`pathPrefix`	string		The path prefix for the route
`ns`	string		The namespace
`alias`	string		The alias for the route
`parent`	string	<optional>	The parent namespace

Source: index.js, line 588

Returns:

The built route

Type:: Object

(async) _serveRoute(options) → {Object}

Serve a route.

Parameters:

Name Type Description

options

Object

The options for serving the route

Properties

Name	Type	Attributes	Description
`mod`	Object		The module object
`ns`	string		The namespace
`parent`	string	<optional>	The parent namespace

Source: index.js, line 458

Returns:

The served route

Type:: Object

docSchemaDescription(method) → {string}

Generate the schema description for a given method.

Parameters:

Name	Type	Description
`method`	string	The method name

Source: index.js, line 145

Returns:

The schema description

Type:: string

(async) docSchemaForFind(items) → {Object}

Generate the schema for the "find" operation.

Parameters:

Name	Type	Description
`items`	Object	The items schema

Source: index.js, line 164

Returns:

The schema for the "find" operation

Type:: Object

(async) docSchemaGeneral() → {Object}

Generate the general schema for the API responses.

Source: index.js, line 187

Returns:

The general schema for API responses

Type:: Object

(async) docSchemaLib(name, obj)

Add a schema to the library.

Parameters:

Name	Type	Description
`name`	string	The name of the schema
`obj`	Object	The schema object

Source: index.js, line 256

(async) docSchemaModel(param0) → {Object}

Generate the schema for a model method.

Parameters:

Name Type Description

param0

Object

The parameters for generating the schema

Properties

Name	Type	Attributes	Default	Description
`model`	string			The model name
`method`	string			The method name
`options`	Object	<optional>	{}	Additional options for schema generation

Source: index.js, line 274

Returns:

The generated schema

Type:: Object

(async) docSchemaParams(paramName, …args) → {void}

Generate the schema for query parameters.

Parameters:

Name	Type	Attributes	Description
`paramName`	string		The name of the parameter
`args`	string	<repeatable>	The arguments for the parameter schema

Source: index.js, line 334

Returns:

Type:: void

(async) docSchemaQs(paramName, …args) → {void}

Generate the schema for query string parameters.

Parameters:

Name	Type	Attributes	Description
`paramName`	string		The name of the parameter
`args`	string	<repeatable>	The arguments for the parameter schema

Source: index.js, line 370

Returns:

Type:: void

(async) init()

Initialize the plugin.

Source: index.js, line 44