https://github.com/kyoh86/go-docbase
A Go library for accessing the Docbase API v1/v2
https://github.com/kyoh86/go-docbase
api-client docbase go golang library
Last synced: 11 months ago
JSON representation
A Go library for accessing the Docbase API v1/v2
- Host: GitHub
- URL: https://github.com/kyoh86/go-docbase
- Owner: kyoh86
- License: mit
- Created: 2018-04-03T13:59:34.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T10:38:26.000Z (over 1 year ago)
- Last Synced: 2025-03-31T11:35:25.387Z (12 months ago)
- Topics: api-client, docbase, go, golang, library
- Language: Go
- Homepage:
- Size: 48.8 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-docbase
A Go library for accessing the [Docbase](https://docbase.io)
API Docs: https://help.docbase.io/posts/45703
[](https://pkg.go.dev/kyoh86/go-docbase)
[](https://goreportcard.com/report/github.com/kyoh86/go-docbase)
[](https://codecov.io/gh/kyoh86/go-docbase)
[](https://github.com/kyoh86/go-docbase/releases)
## Install
```sh
go get github.com/kyoh86/go-docbase
```
## Usage
### v1
```go
import (
"github.com/kyoh86/go-docbase/docbase"
)
transport := docbase.TokenTransport{Token: "Your API Token"}
client := docbase.NewClient(transport.Client())
...
```
And see [example](./cmd/go-docbase-sample/main.go).
### v2
```go
import (
"github.com/kyoh86/go-docbase/v2/docbase"
)
client := docbase.NewAuthClient("Your DocBase Domain", "Your API Token")
```
And see [example](./v2/cmd/go-docbase-sample/main.go).
## API Coverage Status
### v1
* ○: Implemented and tested.
* △: Implementing.
* ×: Not implemented.
| Service | Function | Status |
| --- | --- | --- |
| Post | List | ○ |
| Post | Create | ○ |
| Post | Get | △ |
| Post | Update | △ |
| Post | Delete | △ |
| Comment | Create | △ |
| Comment | Delete | △ |
| Team | List | ○ |
| Group | List | △ |
| Tag | List | △ |
| Attachment | Post | × |
### v2
| Service | Function | Implemented | Tested |
| --- | --- | --- | --- |
| Post | List | ☑ | ☑ |
| Post | Create | ☑ | ☑ |
| Post | Get | ☑ | ☑ |
| Post | Edit | ☑ | ☑ |
| Post | Archive | ☑ | ☑ |
| Post | Unarchive | ☑ | ☑ |
| Post | Delete | ☑ | ☑ |
| User | List | ☑ | ☑ |
| Comment | Create | ☑ | ☑ |
| Comment | Delete | ☑ | ☑ |
| Attachment | Upload | ☑ | ☑ |
| Tag | List | ☑ | ☑ |
| Group | Create | ☑ | ☑ |
| Group | Get | ☑ | ☑ |
| Group | List | ☑ | ☑ |
| Group | AddUsers | ☑ | ☑ |
| Group | RemoveUsers | ☑ | ☑ |
# LICENSE
[](http://www.opensource.org/licenses/MIT)
This is distributed under the [MIT License](http://www.opensource.org/licenses/MIT).