README.md

simple-api-client-generator

API Client Generator from JSON Hyper Schema.

API Client has generated with Flow types for Request, Response, and Resource. And request parameters is validated with tv4 and power-assert on development phase.

WIP

Installation

npm install --save @moqada/simple-api-client-generator

Usage

Usage: simple-api-client-generator [options] <JSON Schema>

Options:
  -n, --name    API Client class name  [string] [default: "APIClient"]
  -o, --output  output file path  [string]
  -a, --assert  assert library name  [string] [default: "power-assert"]
  -l, --lang    output language  [choices: "javascript", "typescript"] [default: "javascript"]
  --help        Show help  [boolean]
  --version     Show version number  [boolean]

Examples:
  simple-api-client-generator ./shema.json                      Output API Client.
  simple-api-client-generator -n AwesomeAPIClient ./shema.json  Output API Client given name

Output Example is here from Sample JSON Hyper Schema;

Restriction

Depenencies

Generated Client depends on following modules.

• @moqada/simple-api-client
• extend
• power-assert
• tv4
• unassert
  • babel-plugin-unassert
• uri-templates

JSON Hyper Schema

JSON Hyper Schema must have unique rel value per resources.