@rhoas/api-mock v1.0.3

API Mock for RHOAS APIs

Project provides mocking capabilities for RHOAS APIs. Mock supports in memory storage to give developers abstraction of running service.

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

2. Container image

docker run  -p 8080:8000 quay.io/rhosak/api-mock

3. Using as CLI

npm install -g @rhoas/api-mock
## Run CLI
asapi

Starting mock with sample data present:

asapi --pre-seed

Instances API mapping pattern

Mock provides support for managemement and instances APIs

Instance API use following prefixes

• /data/kafka for kafka instance
• /data/service-registry for service registry instance

To simulate multiple instances please run many instances of mock.

Local development

yarn
yarn build
yarn start # API running at http://localhost:9000

Environment variables

CUSTOM_PORT - custom port number used default is 8000

CUSTOM_HOST - custom url used in returned data. default http://localhost

RESOURCE_OWNER - provide custom owner value as we do not have ability to detect it in mock. For example: "RESOURCE_OWNER=wtrocki_kafka_devexp yarn start"

AMS_QUOTA_TYPE - provide the quota type to be mocked. The valid values are - "trial", "standard" and "marketplace".

Build container

docker build -t quay.io/rhosak/api-mock .
docker push quay.io/rhosak/api-mock

API Clients

You can call api by starting individual web clients per api or running examples against mock.

yarn api:kafka-management
yarn api:kafka-instance
yarn api:registry-management
yarn api:registry-instance