kinto-cli

Kinto-cli

cli to interface with kintohub api

  Usage: kinto [options] [command]

  Options:

    -v, --version              output the version number
    -h, --help                 output usage information

  Commands:

    init [options]             Initialize the base env
    view-config                view the config
    clear-config               remove all the saved config (need to do `kinto init` after)
    proxy [options] [appname]  proxy for kintoblocks inside the provided kintoapp
    apidocs [options]          validates/parse apidocs

Apidocs

kinto apidoc

Supports the following

-l for linting (no output file) -e <path> for ignoring (can have multiple)

The tool only spits out kinto-apidoc.json not a whole folder

Processing

Modify groups for @apiSuccess and @apiError to modify 200, 400 to Success_200 and Error_400, so it allows the user to use groups like @apiSuccess (200) in the code

Default Groups

add the following custom groups if non is specified

• @apiParam adds Body as the default group
• @apiHeader adds Header as the default group
• @apiSuccess adds 200 as the default group
• @apiFailer adds 400 as the default group

Validations

• show the validation errors grouped by @apiName

Validates the following:

• must have documentation in project
• @api required http verb and url per endpoint
• @apiName check uniqueness per project and required for each endpoint
• @apiSuccess
  • check uniqueness per endpoint
  • check the group is numerical (can also be Success_<number>) or Session
• @apiError
  • check uniqueness per endpoint
  • check the group is numerical or (can also be Error_<number>) or Session
• @apiHeader
  • check uniqueness per endpoint
  • check if group is Header,Session or Config
• @apiParam
  • check uniqueness per endpoint
  • check if group is Url,Body or QueryString

When validation fails, no file is gonna be outputted and the process will exit with error

Remote block Debug:

• use example.localdebug.config.json as a local debug example config

• to run kinto proxy with a config:

      kinto proxy -f app.config.json
  

TODOS:

• can't check uniquness for the field name, apidoc parser merges the same field name
• APIDOC-PARSER scope is not failing the app
• can't validate require @apiName if non is provided apidoc generates one