Skip to content

Rest api implementation in golang of atlassian's confluence wiki

License

Notifications You must be signed in to change notification settings

Virtomize/confluence-go-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

bb961e5 · Aug 8, 2022
Jul 28, 2020
Apr 5, 2022
Sep 1, 2020
Aug 16, 2021
Jul 2, 2019
Jul 28, 2020
Jun 29, 2018
Nov 17, 2021
Nov 10, 2021
Nov 19, 2021
Nov 19, 2021
Aug 8, 2022
Jul 8, 2020
Jul 28, 2020
Jul 28, 2020
Jul 28, 2020
Nov 19, 2021
Nov 19, 2021
Mar 20, 2019
Nov 19, 2021
Jun 4, 2022
Aug 16, 2021
Mar 21, 2019
Aug 16, 2021
May 8, 2019
Aug 16, 2021
Oct 12, 2020
Jun 4, 2022
Jun 4, 2022

Repository files navigation

confluence-go-api

Donate GoDoc Go Report Card License Build Status Built with Mage

is a Confluence REST API client implementation written in GOLANG.

Supported Features

  • get, update, delete content
  • get, update, delete content templates and blueprints
  • get comments, attachments, children of content objects, history, watchers
  • get, add ,delete labels
  • get user information
  • search using CQL

If you miss some feature implementation, feel free to open an issue or send pull requests. I will take look as soon as possible.

Donation

If this project helps you, feel free to give us a cup of coffee :).

paypal

Installation

If you already installed GO on your system and configured it properly than its simply:

go get github.com/virtomize/confluence-go-api

If not follow these instructions

Usage

Simple example

package main

import (
  "fmt"
  "log"

  "github.com/virtomize/confluence-go-api"
)

func main() {

  // initialize a new api instance
  api, err := goconfluence.NewAPI("https://<your-domain>.atlassian.net/wiki/rest/api", "<username>", "<api-token>")
  if err != nil {
    log.Fatal(err)
  }

  // get current user information
  currentUser, err := api.CurrentUser()
  if err != nil {
    log.Fatal(err)
  }
  fmt.Printf("%+v\n", currentUser)
}

Using a Personal Access Token

To generate a confluence personal access token (PAT) see this article: https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html. Only set the token in the NewAPI function

  api, err := goconfluence.NewAPI("https://<your-domain>.atlassian.net/wiki/rest/api", "", "<personal-access-token>")

Advanced examples

see examples for some more usage examples

Code Documentation

You find the full code documentation here.

The Confluence API documentation can be found here.

Contribution

Thank you for participating to this project. Please see our Contribution Guidlines for more information.