Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yitsushi/go-misskey

Misskey Go SDK
https://github.com/yitsushi/go-misskey

golang hacktoberfest misskey misskey-client sdk

Last synced: 3 days ago
JSON representation

Misskey Go SDK

Host: GitHub
URL: https://github.com/yitsushi/go-misskey
Owner: yitsushi
License: gpl-3.0
Created: 2020-10-08T09:51:35.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2023-12-13T10:10:10.000Z (about 1 year ago)
Last Synced: 2024-04-15T14:03:11.964Z (10 months ago)
Topics: golang, hacktoberfest, misskey, misskey-client, sdk
Language: Go
Homepage:
Size: 427 KB
Stars: 45
Watchers: 4
Forks: 10
Open Issues: 9
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        [![Go Report Card](https://goreportcard.com/badge/github.com/yitsushi/go-misskey)](https://goreportcard.com/report/github.com/yitsushi/go-misskey)

[![Coverage Status](https://coveralls.io/repos/github/yitsushi/go-misskey/badge.svg?branch=main)](https://coveralls.io/github/yitsushi/go-misskey?branch=main)

[![GoDoc](https://img.shields.io/badge/pkg.go.dev-doc-blue)](http://pkg.go.dev/github.com/yitsushi/go-misskey)

[![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#go-misskey:matrix.org)

# Misskey Go SDK

Misskey API Documentation: https://slippy.xyz/api-doc

Check the `docs` directory for more information.

For examples on given endpoints, please check the corresponding `_test.go` file,

they have at least one `ExampleService_XYZ` function, examples:

- [How to create a note](https://github.com/yitsushi/go-misskey/blob/main/services/notes/create_test.go#L73)

- [How to renote](https://github.com/yitsushi/go-misskey/blob/main/services/notes/renotes_test.go#L51)

- [How to upload a file](https://github.com/yitsushi/go-misskey/blob/main/services/drive/files/create_test.go#L39)

- [How to create a notification](https://github.com/yitsushi/go-misskey/blob/main/services/notifications/create_test.go#L33)

## Progress

| Status | Endpoint Group | Implementation Issue | Note |

|--------|----------------|----------------------|------|

| :white_check_mark: | [antennas](https://misskey.io/api-doc#tag/antennas) | [#3](https://github.com/yitsushi/go-misskey/issues/3) ||

| :white_check_mark: | [app](https://misskey.io/api-doc#tag/app) | [#5](https://github.com/yitsushi/go-misskey/issues/5) ||

| :white_check_mark: | [clips](https://misskey.io/api-doc#tag/clips) | [#8](https://github.com/yitsushi/go-misskey/issues/8) ||

| :white_check_mark: | [drive](https://misskey.io/api-doc#tag/drive) | [#9](https://github.com/yitsushi/go-misskey/issues/9) ||

| :white_check_mark: | [federation](https://misskey.io/api-doc#tag/federation) | [#4](https://github.com/yitsushi/go-misskey/issues/4) ||

| :white_check_mark: | [following](https://misskey.io/api-doc#tag/following) | [#10](https://github.com/yitsushi/go-misskey/issues/10) ||

| :white_check_mark: | [groups](https://misskey.io/api-doc#tag/groups) | [#19](https://github.com/yitsushi/go-misskey/issues/19) ||

| :white_check_mark: | [hashtags](https://misskey.io/api-doc#tag/hashtags) | [#12](https://github.com/yitsushi/go-misskey/issues/12) ||

| :white_check_mark: | [meta](https://misskey.io/api-doc#tag/meta) | ||

| :white_check_mark: | [notes](https://misskey.io/api-doc#tag/notes) | [#6](https://github.com/yitsushi/go-misskey/issues/6) ||

| :white_check_mark: | [notifications](https://misskey.io/api-doc#tag/notifications) | [#15](https://github.com/yitsushi/go-misskey/issues/15) ||

| :white_check_mark: | [reactions](https://misskey.io/api-doc#tag/reactions) | [#14](https://github.com/yitsushi/go-misskey/issues/14) ||

| :warning: | [admin](https://misskey.io/api-doc#tag/admin) | [#21](https://github.com/yitsushi/go-misskey/issues/21) | In Progress (84%) |

| :x: | [account](https://misskey.io/api-doc#tag/account) |||

| :x: | [auth](https://misskey.io/api-doc#tag/auth) |||

| :x: | [channels](https://misskey.io/api-doc#tag/channels) |||

| :x: | [charts](https://misskey.io/api-doc#tag/charts) | [#7](https://github.com/yitsushi/go-misskey/issues/7) ||

| :x: | [list](https://misskey.io/api-doc#tag/lists) | [#20](https://github.com/yitsushi/go-misskey/issues/20) ||

| :x: | [messaging](https://misskey.io/api-doc#tag/messaging) | [#13](https://github.com/yitsushi/go-misskey/issues/13) ||

| :x: | [pages](https://misskey.io/api-doc#tag/pages) | [#16](https://github.com/yitsushi/go-misskey/issues/16) ||

| :x: | [users](https://misskey.io/api-doc#tag/users) | [#17](https://github.com/yitsushi/go-misskey/issues/17) | |

## How to use

For detailed examples, check the `example` directory.

```go

package main

import (

	"log"

	"os"

	"github.com/sirupsen/logrus"

	"github.com/yitsushi/go-misskey"

	"github.com/yitsushi/go-misskey/core"

	"github.com/yitsushi/go-misskey/services/meta"

)

func main() {

	client, err := misskey.NewClientWithOptions(

		misskey.WithAPIToken(os.Getenv("MISSKEY_TOKEN")),

		misskey.WithBaseURL("https", "slippy.xyz", ""),

		misskey.WithLogLevel(logrus.DebugLevel),

	)

	if err != nil {

		logrus.Error(err.Error())

	}

	stats, err := client.Meta().Stats()

	if err != nil {

		log.Printf("[Meta] Error happened: %s", err)

		return

	}

	log.Printf("[Stats] Instances:          %d", stats.Instances)

	log.Printf("[Stats] NotesCount:         %d", stats.NotesCount)

	log.Printf("[Stats] UsersCount:         %d", stats.UsersCount)

	log.Printf("[Stats] OriginalNotesCount: %d", stats.OriginalNotesCount)

	log.Printf("[Stats] OriginalUsersCount: %d", stats.OriginalUsersCount)

}

```

## How can I get a Misskey Token?

Navigate to `Settings > API` and there you generate a new token.

## How can I debug what's wrong?

There is a logging system, right now it's not very wide spread

in the codebase, but if you turn it on, you will be able to see:

 - all request with method, endpoint and body

 - all responds with status code, from what endpoint told and the body

To enable debug mode, just change the `LogLevel` to `DebugLevel`:

```go

client, _ := misskey.NewClientWithOptions(

	misskey.WithAPIToken(os.Getenv("MISSKEY_TOKEN")),

	misskey.WithBaseURL("https", "slippy.xyz", ""),

	misskey.WithLogLevel(logrus.DebugLevel),

)

```

The output should look like this:

```

DEBU[0000] POST https://slippy.xyz/api/antennas/show     _type=request

DEBU[0000] {"antennaId":"8dbpybhulw","i":"my misskey token"}  _type=request

DEBU[0000] {"id":"8dbpybhulw","createdAt":"2020-10-13T16:03:22.674Z","name":"Genshin Impact","keywords":[["genshin"]],"excludeKeywords":[[""]],"src":"all","userListId":null,"userGroupId":null,"users":[""],"caseSensitive":false,"notify":false,"withReplies":true,"withFile":false,"hasUnreadNote":false}  _type=response code=200 from="https://slippy.xyz/api/antennas/show"

```