Commandline interface for generating and linting apibuilder api specs.

Go to file

Jenkins a8c9639b52 nclazz/api-cli/pipeline/head This commit looks good Details NClazz/api-cli/pipeline/head There was a failure building this commit Details 1.1.1		2021-07-08 19:05:42 +02:00
src	updated args-parser 1.2.0 -> 1.3.0	2021-07-08 18:55:22 +02:00
templates	Initial Setup and Linter implementation (#1 )	2021-07-07 20:21:46 +00:00
tests	Initial Setup and Linter implementation (#1 )	2021-07-07 20:21:46 +00:00
.gitignore	rm package-lock.json to .gitignore	2021-07-07 16:12:44 +02:00
Jenkinsfile	updated Jenkinsfile	2021-07-07 22:44:43 +02:00
README.md	added user info	2021-07-07 14:16:19 +02:00
package-lock.json	1.1.1	2021-07-08 19:05:42 +02:00
package.json	1.1.1	2021-07-08 19:05:42 +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.