zephyr-api-wrapper

Wrapper for Zephyr Scale Cloud API

Usage no npm install needed!

<script type="module">
  import zephyrApiWrapper from 'https://cdn.skypack.dev/zephyr-api-wrapper';
</script>

README

Zephyr-api Library

:warning: Work In Progress... (WIP)

Overview

  • zephyr-api is a wrapper around Zephyr Scale Cloud REST API to automated tasks, test-cycles creations, etc. in JIRA.

Requirements

  • Requires Node.js 14+
  • Set env with zephyr toke ZEPHYR_TOKEN=XXXXXXXXX

Documentation

API specification can be found in -> zephyr-spec

Endpoints implemented

  • :warning: Automation - partially done
  • :warning: TestCycles - partially done
  • :warning: TestCases - partially done
  • :warning: TestExecution - partially done

Example (using Typescript)

NOTE: Remember to set the environment variable ZEPHYR_TOKEN

To use a subset of calls for a specific endpoint:

import { TestCycle } from 'zephyr-api-wrapper';

const api = new TestCycle();

api.getTestCycles().then((result) => {
  console.log(result);
});

To use all the possible calls for:

import { FullZephyrAPI } from 'zephyr-api-wrapper';

const api = new FullZephyrAPI();

api.testCycles.getTestCycles().then((result) => {
  console.log(result);
});

Future Plans

  • Implement all the endpoints
  • Add interfaces for responses/requests
  • Implement tests to check basic functionality
  • Create CI with github actions