atlassian-rest-client
v0.3.4-alpha.0
Published
A simple SDK to with with Atlassian Rest APIs. This project provide you models and classes with methods (like an unofficial SDK) to work with atlassian products like JIRA and Confluence APIs v3
Downloads
306
Readme
Atlassian Rest Client
A simple SDK to with with Atlassian Rest APIs. This project provide you models and classes with methods (like an unofficial SDK) to work with atlassian products like JIRA and Confluence APIs v3
[!NOTE]
This project is active and Work In Progress (WIP). Contributions welcome!!
Installation
To install execute:
npm install atlassian-rest-client
Configuration
In this section, we assume that you know and have your atlassian instance and your token (Personal Access Token).
You should config your credentials into a .env
file or similar
ATLASSIAN_INSTANCE=https://your-domain.atlassian.net
[email protected]
ATLASSIAN_TOKEN=your-token
JIRA Usage
import { Jira } from 'atlassian-rest-client';
const jira: Jira = new Jira(process.env.ATLASSIAN_INSTANCE, process.env.ATLASSIAN_EMAIL, process.env.ATLASSIAN_TOKEN);
Confluence Usage
import {Confluence} from "atlassian-rest-client";
const confluence: Confluence = new Confluence(process.env.ATLASSIAN_INSTANCE, process.env.ATLASSIAN_EMAIL, process.env.ATLASSIAN_TOKEN);