@senzing/rest-api-client-ng

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

Overview

This project is a package that provides a Angular TypeScript REST client intended to be used as a dependency for other Senzing projects like @senzing/sdk-components-ng. This project should conform to the OAS schema defined in Senzing/senzing-rest-api-specification

The usage for classes, models, and services can be found in the documentation examples.

Installation

npm install @senzing/rest-api-client-ng --save

Building from source

git clone git@github.com:Senzing/rest-api-client-ng.git
cd rest-api-client-ng
npm install
npm run build:prod
npm run package

The steps above will checkout the repo and build the package to the ./dist/@senzing/rest-api-client-ng directory. The local package can then be statically installed by using first changing to the directory of your project and doing a npm install ./relative/path/to/dist/@senzing/rest-api-client-ng/rest-api-client-ng.0.0.0.tgz or npm link.

Running unit tests

Run npm run test to execute the unit tests via Karma.