Tutorial: Creating, Reading, Updating, and Deleting Issues and Projects using Jira Cloud REST API with Node.js

In this tutorial, we will be learning how to interact with the JIRA Cloud REST API using Node.js. We will cover how to create, read, update, and delete issues and projects within JIRA Cloud. By the end of this tutorial, you will have a basic understanding of how to use the JIRA Cloud REST API in your Node.js applications.

Prerequisites:

1. Node.js installed on your machine
2. Basic understanding of JavaScript
3. JIRA Cloud account

Step 1: Set up a new Node.js project
First, let’s create a new directory for our project and initialize it with npm.

mkdir jira-api-tutorial
cd jira-api-tutorial
npm init -y

Step 2: Install required dependencies
Next, let’s install the necessary dependencies for our project.

npm install axios dotenv

We will be using the axios library to make HTTP requests to the JIRA Cloud API and the dotenv library to manage environment variables.

Step 3: Create a .env file
Create a .env file in the root of your project and add your JIRA Cloud credentials.

JIRA_EMAIL=your_email@example.com
JIRA_API_TOKEN=your_api_token
JIRA_BASE_URL=your_jira_base_url

Step 4: Create a JIRA API client
Create a new file called jiraClient.js and add the following code to it.

const axios = require('axios');
require('dotenv').config();

const email = process.env.JIRA_EMAIL;
const apiToken = process.env.JIRA_API_TOKEN;
const baseUrl = process.env.JIRA_BASE_URL;

const auth = {
  username: email,
  password: apiToken,
};

const client = axios.create({
  baseURL: baseUrl,
  auth: auth,
});

module.exports = client;

This code sets up an Axios client with your JIRA Cloud credentials and exports it for use in other files.

Step 5: Create a JIRA service
Create a new file called jiraService.js and add the following code to it.

const client = require('./jiraClient');

async function getIssue(issueKey) {
  try {
    const response = await client.get(`/rest/api/3/issue/${issueKey}`);
    return response.data;
  } catch (error) {
    throw new Error(error.response.data.errorMessages[0]);
  }
}

async function createIssue(projectKey, issueType, summary, description) {
  const data = {
    fields: {
      project: {
        key: projectKey,
      },
      issuetype: {
        name: issueType,
      },
      summary: summary,
      description: description,
    },
  };

  try {
    const response = await client.post('/rest/api/3/issue', data);
    return response.data;
  } catch (error) {
    throw new Error(error.response.data.errorMessages[0]);
  }
}

async function updateIssue(issueKey, updates) {
  try {
    const response = await client.put(`/rest/api/3/issue/${issueKey}`, updates);
    return response.data;
  } catch (error) {
    throw new Error(error.response.data.errorMessages[0]);
  }
}

async function deleteIssue(issueKey) {
  try {
    const response = await client.delete(`/rest/api/3/issue/${issueKey}`);
    return response.data;
  } catch (error) {
    throw new Error(error.response.data.errorMessages[0]);
  }
}

module.exports = {
  getIssue,
  createIssue,
  updateIssue,
  deleteIssue,
};

This code defines functions to interact with JIRA Cloud’s issue endpoints, including getting an issue, creating an issue, updating an issue, and deleting an issue.

Step 6: Use the JIRA service in your main file
Create a new file called index.js and add the following code to it to test out the JIRA service.

const jiraService = require('./jiraService');

async function main() {
  // Get an issue
  console.log(await jiraService.getIssue('ISSUE-KEY'));

  // Create an issue
  console.log(await jiraService.createIssue('PROJECT-KEY', 'Bug', 'New bug', 'A new bug has been found.'));

  // Update an issue
  console.log(await jiraService.updateIssue('ISSUE-KEY', { fields: { summary: 'Updated summary' } }));

  // Delete an issue
  console.log(await jiraService.deleteIssue('ISSUE-KEY'));
}

main();

Replace ‘ISSUE-KEY’ and ‘PROJECT-KEY’ with actual issue and project keys in your JIRA Cloud account.

Step 7: Run your Node.js application
To run your Node.js application, execute the following command in your terminal.

node index.js

You should see the output of the JIRA API calls printed to your console.

Congratulations! You have successfully interacted with the JIRA Cloud REST API using Node.js. You can now incorporate this knowledge into your own projects to automate tasks and interact with JIRA Cloud programmatically.