Commandline interface for generating and linting apibuilder api specs.
 
Go to file
Niclas Thobaben 22c28b2247
nclazz/api-cli/pipeline/pr-master This commit looks good Details
NClazz/api-cli/pipeline/head There was a failure building this commit Details
nclazz/api-cli/pipeline/head This commit looks good Details
added linter command
2021-07-07 22:20:15 +02:00
src added linter command 2021-07-07 22:20:15 +02:00
templates added tes for gen command 2021-07-07 22:20:14 +02:00
tests added linting to generator 2021-07-07 22:20:14 +02:00
.gitignore rm package-lock.json to .gitignore 2021-07-07 16:12:44 +02:00
Jenkinsfile updated Jenkinsfile 2021-07-07 17:01:06 +02:00
README.md added user info 2021-07-07 14:16:19 +02:00
package-lock.json added cmd.version.test 2021-07-07 22:20:13 +02:00
package.json added cmd.version.test 2021-07-07 22:20:13 +02:00

README.md

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.