addodelgrossi/go-jira

A Go client library for acessing the Jira Agile API

go-jira

go-jira is a Go client library for acessing the Jira Agile API.

Usage

import "github.com/leocomelli/go-jira"

Construct a new Jira Agile client, then use the various services on the client to access different parts of the Jira Agile API. For example:

client, err := jira.NewClient("https://jira.mycompany.com/", nil)
if err != nil {
    // handle error
}

boards, resp, err := client.Boards.ListBoards(context.Background(), nil)

Some API methods have optional parameters that can be passed. For example:

client, err := jira.NewClient("https://jira.mycompany.com/", nil)
if err != nil {
    // handle error
}

opts := &jira.ListBoardsOptions{
    ProjectKeyOrID: "CBD",
}

boards, resp, err := client.Boards.ListBoards(context.Background(), opts)

Authentication

The go-jira library does not directly handle authentication. Instead, when creating a new client, pass an http.Client that can handle authentication for you.

tp := &jira.BasicAuthTransport{
	Username: "myuser",
	Password: "mypass",
}
client, err := jira.NewClient(defaultBaseURL, tp.Client())
if err != nil {
    // handle error
}

// use client