NiclasThobaben
/
api-cli
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Commandline interface for generating and linting apibuilder api specs.
28 Commits
3 Branches
3 Tags
143 KiB
JavaScript 100%
 
Go to file
Niclas Thobaben 81c24b7a7d
nclazz/api-cli/pipeline/head This commit looks good Details
Initial Setup and Linter implementation (#1) 
Co-authored-by: Niclas Thobaben <nt@noske-office.de>
Reviewed-on: de.nclazz/api-cli#1
Co-authored-by: Niclas Thobaben <niclas@die-thobabens.de>
Co-committed-by: Niclas Thobaben <niclas@die-thobabens.de>
 		2021-07-07 20:21:46 +00:00
src Initial Setup and Linter implementation (#1) 2021-07-07 20:21:46 +00: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 17:01:06 +02:00
README.md added user info 2021-07-07 14:16:19 +02:00
package-lock.json Initial Setup and Linter implementation (#1) 2021-07-07 20:21:46 +00:00
package.json Initial Setup and Linter implementation (#1) 2021-07-07 20:21:46 +00: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.