Expresso-api NPM

ExpressO

An Express.js CLI tool to statically analyze the backend, generating the specification for its routes using the OpenAPI standard.

npm install -g expresso-api

This will allow you to use the expresso command from anywhere.

The project for which you wish to generate the OpenAPI specification should:

This command is used to generate the OpenAPI3.0 specification relative to an Express.js project by statically analyzing it.

Usage: expresso generate [--root] [--start] [--output] [--ext]

Description:

Command	Alias	Description	Default
`--root`		Specifies the root of the Express.js project to generate an OpenAPI specification for, defaults to current working directory.	`process.cwd()`
`--start`		The command line that will be used to start the project.	`npm start`
`--output`	`-O`	Specifies a path of where to output the OpenAPI specification.	`./expresso-openapi`
`--ext`	`-E`	Specifies which format to use for the output between `json` and `yaml`.	`json`

This command takes as input another specification and compares it to the one that the tool generates.

Usage: expresso test <OAPIspec> [--root] [--start] [--output] [--ext]

Argument	Description
`OAPIspec`	Specifies the file path that points to the OpenAPI specification that the generated one will be tested against.

Command	Alias	Description	Default
`--root`		Specifies the root of the Express.js project to generate an OpenAPI specification for, defaults to current working directory.	`process.cwd()`
`--start`		The command line that will be used to start the project.	`npm start`
`--output`	`-O`	Specifies a path of where to output the OpenAPI specification.	`./expresso-openapi`
`--ext`	`-E`	Specifies which format to use for the output between `json` and `yaml`.	`json`

Usage: expresso compare <OAPIspecA> <OAPIspecB> [--json]

Argument	Description
`OAPIspecA`	Specifies the file path that points to an OpenAPI specification.
`OAPIspecB`	Specifies the file path that points to a second OpenAPI specification that will be compared to `OAPIspecA`

Command	Alias	Description	Default
`--json`	`-J`	Specifies to produce a JSON instead of a human readable report	`False`

The response mining has issues with local identifiers. Global constants are self explanatory but local variables (e.g: status) does not say anything about the type of response.