@senzing/rest-api-client-ng

A package providing restful http interfaces to typescript interfaces to @senzing/senzing-api-server. Utilizes the OpenAPI spec defined in the https://github.com/Senzing/senzing-rest-api-specification repository.

Usage no npm install needed!

<script type="module">
  import senzingRestApiClientNg from 'https://cdn.skypack.dev/@senzing/rest-api-client-ng';
</script>

README

@senzing/rest-api-client-ng

Build Status npm version GitHub release (latest SemVer) GitHub package.json version

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.