This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json
. (Reference)
To build and compile the typescript sources to javascript use:
npm install
npm run build
First build the package then run npm publish
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @teemill/file-processor@0.3.4 --save
unPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --save
All URIs are relative to https://api.localhost:8080
Class | Method | HTTP request | Description |
---|---|---|---|
HealthApi | getHealth | GET /healthz | Get health |
ProcessorApi | createJob | POST /jobs | Create job |
ProcessorApi | deleteJob | DELETE /jobs/{job} | Delete job |
ProcessorApi | getJob | GET /jobs/{job} | Get job |
ProcessorApi | listJobs | GET /jobs | List jobs |
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
- Type: OAuth
- Flow: password
- Authorization URL:
- Scopes: N/A