@zencastr/zencastr-api-connector

Zencastr core

This library serves as a connector for the Zencastr REST API. It can be used as on the client and server. It uses AXIOS for HTTP calls.

src/models

/types

This is where the types that represent the Zencastr entities sent from the rest API are defined as interfaces. All of these interfaces can be used as an interface for object literals, as well as mongoose schemas.

src/fixtures

/responses

These are the hardcoded responses from the Zencastr api. These can be used to understand the response data better. Changing the config property config.platform.useFixtures will make the API return these fixtures for the associated endpoints at the HTTP request builder level.

src/services

These are the individual services that map to the entities in zencastr. Each endpoint should return a Promise<Response>. Responses are stored in src/responses.