Have ideas to improve npm?Join in the discussion! »

@capterqa/cli

1.0.0-alpha.26 • Public • Published

Capter logo

@capterqa/cli

test-build codecov npm

Capter is a lightweight end-to-end testing tool for APIs. It's language agnostic and can test APIs written in any language (Node.js, Go etc).

  • 🧑‍💻 Write tests in YAML
  • 🔎 Run the same tests locally, in CI, or as a cron job to monitor your live APIs
  • 🏃‍♂️ Takes less than a minute to get started

How it works:

Create a workflow file in a .capter folder:

# .capter/products.yml

name: products
steps:
  - name: fetch all products
    id: products
    url: ${{ env.URL }}/api/products
    assertions:
      - !expect status to_equal 200
      - !expect body to_be_array

  - name: fetch first product
    url: ${{ env.URL }}/api/posts/${{ products.response.body.0.id }}
    assertions:
      - !expect body.id to_equal ${{ products.response.body.0.id }}

Then run the CLI:

URL=http://localhost:3000 capter test

Demo

CLI

Installation

# npm
npm i @capterqa/cli --save-dev

# yarn
yarn add @capterqa/cli --dev

During the alpha, you need to add GITHUB_TOKEN to .env for the CLI install.

Getting started

Follow the instructions in the documentation to get started:

API

License

The Capter CLI is provided under the MIT License. See LICENSE for details.

Keywords

none

Install

npm i @capterqa/cli

DownloadsWeekly Downloads

295

Version

1.0.0-alpha.26

License

MIT

Unpacked Size

7.45 kB

Total Files

6

Last publish

Collaborators

  • avatar