go-docbase's Introduction

go-docbase

A Go library for accessing the Docbase

API Docs: https://help.docbase.io/posts/45703

Install

go get github.com/kyoh86/go-docbase

Usage

v1

import (
	"github.com/kyoh86/go-docbase/docbase"
)

transport := docbase.TokenTransport{Token: "Your API Token"}
client := docbase.NewClient(transport.Client())
...

And see example.

v2

import (
	"github.com/kyoh86/go-docbase/v2/docbase"
)

client := docbase.NewAuthClient("Your DocBase Domain", "Your API Token")

And see example.

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

This is distributed under the MIT License.

go-docbase's People

Contributors

Stargazers

Watchers

go-docbase's Issues

Use GitHub Actions

yo go-project --projectName ${PWD##*/} --author ${${PWD%/*}##*/} --license MIT --dir ${PWD}
git rm -rf .circleci
sudo rm -rf "$(go env GOPATH)/pkg" && go get -v -d -t ./... && go mod tidy
git add -p and git commit -m "Replace Circle-CI with GitHub Actions"
Set CODECOV_TOKEN and GORELEASER_GITHUB_TOKEN on repository

Recommend Projects