Skip to content

Latest commit

 

History

History
101 lines (71 loc) · 4.62 KB

README.md

File metadata and controls

101 lines (71 loc) · 4.62 KB
Raw

RHOAS SDK for Typescript

Typescript packages and API clients for RHOAS services

Prequisites

Introduction

RHOAS TypeScript SDK's are delivered as set of the individual npm packages. SDK's are divided into two types:

  • Management SDKs - support creating services
  • Instance SDKs - support interaction with services (limited to capabilities not supported by upstream tools)

Typically developers need to integrate with Management SDK's to create or manage service instances and later use upstream libraries or management SDK's to interact with services.

You can view all SDK packages directly in npm

Management SDK's

Name Package name Status Version NPM Docs
kafka @rhoas/kafka-management-sdk beta kafkashield npm doc
service-accounts @rhoas/service-accounts-sdk alpha sashield npm doc
connector @rhoas/connector-management-sdk alpha connectorshield npm doc
service registry @rhoas/registry-management-sdk alpha registryshield npm doc
smart events @rhoas/smart-events-management-sdk alpha smarteventsshield npm doc

Instances SDK's

Name Package name Status Version NPM Docs
kafka @rhoas/kafka-instance-sdk beta kinstanceshield npm doc
service registry @rhoas/registry-instance-sdk beta srinstanceshield npm doc

Docs

Documentation

Examples

Examples

Contributing

Contributions are welcome. See CONTRIBUTING for details.

Using API Mock

Every SDK provided by RHOAS has available API mock. Mock provides simulation of in memory implementation of APIs that can be used for development and testing.

  1. Inline install and usage
npx @rhoas/api-mock
  1. Container image
docker run  -p 8080:8000 quay.io/rhosak/api-mock
  1. Using as CLI
npm install -g @rhoas/api-mock
## Run CLI
asapi