https://github.com/ionos-cloud/api-mock

https://github.com/ionos-cloud/api-mock

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ionos-cloud/api-mock
• Owner: ionos-cloud
• Created: 2020-12-31T10:10:37.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-09T11:52:45.000Z (about 1 year ago)
• Last Synced: 2024-12-26T08:27:39.321Z (4 months ago)
• Language: TypeScript
• Size: 675 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
@ionos-cloud/api-mock

=====================

Ionos Cloud API Mock Engine

![CI](https://github.com/ionos-cloud/api-mock/workflows/CI/badge.svg)

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g @ionos-cloud/api-mock

$ csdk-api-mock COMMAND

running command...

$ csdk-api-mock (-v|--version|version)

@ionos-cloud/api-mock/1.0.1 darwin-x64 node-v14.15.0

$ csdk-api-mock --help [COMMAND]

USAGE

  $ csdk-api-mock COMMAND

...

```

# Commands

* [`csdk-api-mock help [COMMAND]`](#csdk-api-mock-help-command)

* [`csdk-api-mock run [FILE]`](#csdk-api-mock-run-file)

## `csdk-api-mock help [COMMAND]`

display help for csdk-api-mock

```

USAGE

  $ csdk-api-mock help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.1/src/commands/help.ts)_

## `csdk-api-mock run [FILE]`

run a mock server using an endpoint map

```

USAGE

  $ csdk-api-mock run [FILE]

OPTIONS

  -d, --debug

  -h, --help       show CLI help

  -p, --port=port  [default: 8080]

EXAMPLE

  $ csdk-api-mock run map.json

```

_See code: [src/commands/run.ts](https://github.com/ionos-cloud/api-mock/blob/v1.0.1/src/commands/run.ts)_