Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vvatanabe/go-backlog
go-backlog is a GO client library for accessing the Backlog API.
https://github.com/vvatanabe/go-backlog
Last synced: 24 days ago
JSON representation
go-backlog is a GO client library for accessing the Backlog API.
- Host: GitHub
- URL: https://github.com/vvatanabe/go-backlog
- Owner: vvatanabe
- License: mit
- Created: 2018-06-07T12:03:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-12T09:37:28.000Z (about 3 years ago)
- Last Synced: 2024-05-21T12:37:59.793Z (6 months ago)
- Language: Go
- Homepage: https://developer.nulab-inc.com/docs/backlog/
- Size: 61.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# go-backlog [](https://travis-ci.org/vvatanabe/go-backlog) [](https://coveralls.io/github/vvatanabe/go-backlog?branch=master)
go-backlog is a GO client library for accessing the [Backlog API](https://developer.nulab-inc.com/docs/backlog/).
## Installation
This package can be installed with the go get command:
```
$ go get github.com/vvatanabe/go-backlog
```
## Usage
### Import
``` go
import "github.com/vvatanabe/go-backlog/backlog/v2"
```
### Access APIs using API Key
```go
package main
import (
"context"
"fmt"
"github.com/vvatanabe/go-backlog/backlog/v2"
)
func main() {
client := v2.NewClient("example.backlog.jp", nil)
client.SetAPIKey("yourAPIKey")
ctx := context.Background()
issueIDOrKey := "EXAMPLE-1"
issue, resp, err := client.Issues.GetIssue(ctx, issueIDOrKey)
if err != nil {
fmt.Printf("code: %v, err: %v", resp.StatusCode, err.Error())
}
fmt.Printf("value: %v", issue)
}
```
## Bugs and Feedback
For bugs, questions and discussions please use the Github Issues.
## License
[MIT License](http://www.opensource.org/licenses/mit-license.php)
## Support API
- [x] [get space](https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-space/)
- [x] [get space disk usage](https://developer.nulab.com/docs/backlog/api/2/get-space-disk-usage/#get-space-disk-usage)
- [x] [get issue](https://developer.nulab-inc.com/docs/backlog/api/2/get-issue/)
- [x] [add issue](https://developer.nulab-inc.com/docs/backlog/api/2/add-issue/)
- [x] [get project](https://developer.nulab-inc.com/docs/backlog/api/2/get-project/)
- [x] [get project user list](https://developer.nulab-inc.com/docs/backlog/api/2/get-project-user-list//)
- [x] [get issue type list](https://developer.nulab-inc.com/docs/backlog/api/2/get-issue-type-list/)
- [x] [add category list](https://developer.nulab-inc.com/docs/backlog/api/2/get-category-list/)
- [x] [get version milestone list](https://developer.nulab-inc.com/docs/backlog/api/2/get-version-milestone-list/)
- [x] [get custom field list](https://developer.nulab-inc.com/docs/backlog/api/2/get-custom-field-list/)
- [x] [get priority list](https://developer.nulab-inc.com/docs/backlog/api/2/get-priority-list/)
- [x] [get pull request](https://developer.nulab.com/ja/docs/backlog/api/2/get-pull-request/)
- [x] [add pull request comment](https://developer.nulab.com/docs/backlog/api/2/add-pull-request-comment/)
- [x] [get pull request comment](https://developer.nulab.com/docs/backlog/api/2/get-pull-request-comment/)
- [x] [update pull request comment](https://developer.nulab.com/docs/backlog/api/2/update-pull-request-comment-information/)