Categorygithub.com/biome-search/confluence-go-api
repositorypackage
1.3.2
Repository: https://github.com/biome-search/confluence-go-api.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# 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/biome-search/confluence-go-api```

If not follow [these instructions](https://nats.io/documentation/tutorials/go-install/).

## Usage

### Simple example

package main

import ( "fmt" "log"

"github.com/biome-search/confluence-go-api" )

func main() {

// initialize a new api instance api, err := goconfluence.NewAPI("https://.atlassian.net/wiki/rest/api", "", "") 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](https://github.com/biome-search/confluence-go-api/tree/master/examples) for some more usage examples

## Code Documentation

You find the full [code documentation here](https://godoc.org/github.com/biome-search/confluence-go-api).

The Confluence API documentation [can be found here](https://docs.atlassian.com/ConfluenceServer/rest/6.9.1/).

## Contribution

Thank you for participating to this project.
Please see our [Contribution Guidlines](https://github.com/biome-search/confluence-go-api/blob/master/CONTRIBUTING.md) for more information.