Global

Methods

add(container, args)

Add a new service descriptor to the project

Parameters:
Name Type Description
container Object

Container context object, holds config data of the application and supporting functions.
args Object

Command arguments object. Contains the name-value pairs of command arguments.

addBulk(container, args)

Add one or more new service descriptors to the project in bulk mode

Parameters:
Name Type Description
container Object

Container context object, holds config data of the application and supporting functions.
args Object

Command arguments object. Contains the name-value pairs of command arguments.

copyDocDependencies()

Copy files needed by the documentation

copyEndpoints()

Copy the whole services tree (temporary solution)

create(container, args)

Create a new REST API project

Parameters:
Name Type Description
container Object

Container context object, holds config data of the application and supporting functions.
args Object

Command arguments object. Contains the name-value pairs of command arguments.

generateServiceDoc(serviceDesc, context)

Generate the HTML page for one service endpoint descriptor

Parameters:
Name Type Description
serviceDesc Object

The service descriptor object
context Object

Configuration parameters. See config.load()

makeRelPath(path) → {String}

Make a path string surely relative

Parameters:
Name Type Description
path String

A string that represents an absolute or relative path
Returns:
  • The relative path
Type
String

update(container, args)

Generate the HTML format documentation

Parameters:
Name Type Description
container Object

Container context object, holds config data of the application and supporting functions.
args Object

Command arguments object. Contains the name-value pairs of command arguments.

update(container, args) → {bool}

Update test cases or create them, if they are missing

Parameters:
Name Type Description
container Object

Container context object, holds config data of the application and supporting functions.
args Object

Command arguments object. Contains the name-value pairs of command arguments.
Returns:
  • true if succesfully executed, false otherwise
Type
bool