sngular/api-mock-runner

Create mocks servers with its schemas from OpenAPI 3.0.0 spec files

Welcome to api-mock-runner 👋

Run multiple mock servers from one or more OpenAPI Specification.

Schemas can be provided from a remote origin (https:// or git@) or a local path.

Remote and circular references are allowed.

📘 Usage

You can use api-mock-runner in a three different ways. All of them starts a CLI guided journey:

1. NPX (No installation needed)

npx @sngular/api-mock-runner

2. Globally

sudo npm install --global @sngular/api-mock-runner

To use: type api-mock-runner in the terminal.

3. Current project dev dependency

npm i --save-dev @sngular/api-mock-runner

Manual options

You could avoid CLI interaction by using api-mock-runner with flags. To explore manual options, use -h flag:

npx @sngular/api-mock-runner -h

Usage: api-mock-runner [options]

Options:
  -o, --origin <origin>          path or repo containing schemas
  -s, --schema [schemaPaths...]  path to schemas
  -p, --port [ports...]          port to serve each schema
  -r, --run-config               use saved config
  -h, --help                     display help for command

Response selection

The application will return the first response found in the schema by default. To use another existing response, use prefer header with the content statusCode=XXX in the request.

prefer: statusCode=500

Architectural Decision Record (ADR)

Here you can find architectural decisions records

❤️ Special thanks

We would like to express our special thanks to open-api-mocker, which is used to set up a mock server.

api-mock-runner's Issues

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀