api-cli/README.md

729 B

API-CLI

A commandline interface for generating and linting apibuilder-based api-specs.

Installation

npm install -g @nclazz/api-cli

Generate a new service

Generating is a new service spec is easily done with the generate command.

i.e.:

api-cli generate --name=myservice --description="My Service description" --silent

As a template a default template will be used. The template can be overridden either by specifying it as a parameter --template= or by creating a template json file in ~/.api/templates/default.json

If the parameter --silent is not given an interactive prompt will lead through the generation process.