Categorygithub.com/jessemillman/confluence-go-api
modulepackage
1.0.5
Repository: https://github.com/jessemillman/confluence-go-api.git
Documentation: pkg.go.dev

# README

confluence-go-api

GoDoc Go Report Card License Build Status Built with Mage

is a Confluence REST API client implementation written in GOLANG.

Supportet Features

  • get, update, delete content
  • 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.

Installation

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

go get github.com/cseeger-epages/confluence-go-api

If not follow these instructions.

Usage

Simple example

package main

import (
  "fmt"
  "log"

  "github.com/cseeger-epages/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)
}

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.

# Packages

No description provided by the author

# Functions

Debug outputs debug messages.
NewAPI implements API constructor.
SetDebug enables debug output.

# Variables

DebugFlag is the global debugging variable.

# Structs

AllSpaces results.
AllSpacesQuery defines the query parameters Query parameter values https://developer.atlassian.com/cloud/confluence/rest/#api-space-get.
Ancestor defines ancestors to create sub pages.
API is the main api data structure.
Body holds the storage information.
Content specifies content properties.
ContentQuery defines the query parameters used for content related searching Query parameter values https://developer.atlassian.com/cloud/confluence/rest/#api-content-get.
ContentSearch results.
History contains object history information.
Label contains label information.
Labels is the label containter type.
LastUpdated contains information about the last update.
Results array.
Search results.
SearchQuery defines query parameters used for searchng Query parameter values https://developer.atlassian.com/cloud/confluence/rest/#api-search-get.
Space holds the Space information of a Content Page.
Storage defines the storage information.
User defines user informations.
Version defines the content version number the version number is used for updating content.
Watcher contains information about watching users of a page.
Watchers is a list of Watcher.