golang访问MyAnimeList API的客户端插件库go-myanimelist的使用

项目介绍

go-myanimelist 是一个用于访问 MyAnimeList API v2 的 Go 客户端库。该项目已更新以支持 MyAnimeList API v2，并且自2017年3月起被收录在 awesome-go 中。

安装

使用以下命令安装该包：

go get github.com/nstratos/go-myanimelist/mal

使用方式

导入包：

import "github.com/nstratos/go-myanimelist/mal"

首先创建一个新的 mal 客户端：

c := mal.NewClient(nil)

然后使用客户端的服务（User、Anime、Manga 和 Forum）来访问不同的 MyAnimeList API 方法。

认证

访问公开信息

要访问公共信息，你需要在请求中添加 X-MAL-CLIENT-ID 头部。可以通过创建一个带有自定义传输的 http.Client 来实现：

type clientIDTransport struct {
	Transport http.RoundTripper
	ClientID  string
}

func (c *clientIDTransport) RoundTrip(req *http.Request) (*http.Response, error) {
	if c.Transport == nil {
		c.Transport = http.DefaultTransport
	}
	req.Header.Add("X-MAL-CLIENT-ID", c.ClientID)
	return c.Transport.RoundTrip(req)
}

func main() {
	publicInfoClient := &http.Client{
		// 从 https://myanimelist.net/apiconfig 创建客户端ID
		Transport: &clientIDTransport{ClientID: "<Your application client ID>"},
	}

	c := mal.NewClient(publicInfoClient)
	// ...
}

使用 OAuth2 认证

推荐使用 golang.org/x/oauth2 包。完成 OAuth2 流程后，你将获得一个包含访问令牌、刷新令牌和过期日期的 oauth2 令牌。

const storedToken = `
{
	"token_type": "Bearer",
	"access_token": "yourAccessToken",
	"refresh_token": "yourRefreshToken",
	"expiry": "2021-06-01T16:12:56.1319122Z"
}`

oauth2Token := new(oauth2.Token)
_ = json.Unmarshal([]byte(storedToken), oauth2Token)

// 从 https://myanimelist.net/apiconfig 创建客户端ID和密钥
//
// 如果选择应用类型为"other"，则密钥目前是可选的
oauth2Conf := &oauth2.Config{
    ClientID:     "<Enter your registered MyAnimeList.net application client ID>",
    ClientSecret: "<Enter your registered MyAnimeList.net application client secret>",
    Endpoint: oauth2.Endpoint{
        AuthURL:   "https://myanimelist.net/v1/oauth2/authorize",
        TokenURL:  "https://myanimelist.net/v1/oauth2/token",
        AuthStyle: oauth2.AuthStyleInParams,
    },
}

oauth2Client := oauth2Conf.Client(ctx, oauth2Token)

// oauth2Client 将在令牌过期时刷新令牌
c := mal.NewClient(oauth2Client)

完整示例

以下是一个完整的示例，展示如何使用 go-myanimelist 库访问 MyAnimeList API：

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"net/http"
	"time"

	"github.com/nstratos/go-myanimelist/mal"
	"golang.org/x/oauth2"
)

func main() {
	// 使用 OAuth2 认证
	const storedToken = `
	{
		"token_type": "Bearer",
		"access_token": "yourAccessToken",
		"refresh_token": "yourRefreshToken",
		"expiry": "2021-06-01T16:12:56.1319122Z"
	}`

	oauth2Token := new(oauth2.Token)
	_ = json.Unmarshal([]byte(storedToken), oauth2Token)

	oauth2Conf := &oauth2.Config{
		ClientID:     "<Your Client ID>",
		ClientSecret: "<Your Client Secret>",
		Endpoint: oauth2.Endpoint{
			AuthURL:   "https://myanimelist.net/v1/oauth2/authorize",
			TokenURL:  "https://myanimelist.net/v1/oauth2/token",
			AuthStyle: oauth2.AuthStyleInParams,
		},
	}

	ctx := context.Background()
	oauth2Client := oauth2Conf.Client(ctx, oauth2Token)

	// 创建客户端
	c := mal.NewClient(oauth2Client)

	// 获取用户信息
	user, _, err := c.User.MyInfo(ctx)
	if err != nil {
		fmt.Printf("Error getting user info: %v\n", err)
		return
	}
	fmt.Printf("User: %+v\n", user)

	// 搜索动漫
	animeList, _, err := c.Anime.List(ctx, "hokuto no ken",
		mal.Fields{"rank", "popularity", "my_list_status"},
		mal.Limit(5),
	)
	if err != nil {
		fmt.Printf("Error searching anime: %v\n", err)
		return
	}
	fmt.Println("Anime search results:")
	for _, a := range animeList {
		fmt.Printf("- %s (Rank: %d, Popularity: %d)\n", a.Title, a.Rank, a.Popularity)
	}

	// 获取动漫详情
	animeDetails, _, err := c.Anime.Details(ctx, 967,
		mal.Fields{
			"alternative_titles",
			"media_type",
			"num_episodes",
			"start_season",
			"source",
			"genres",
			"studios",
			"average_episode_duration",
		},
	)
	if err != nil {
		fmt.Printf("Error getting anime details: %v\n", err)
		return
	}
	fmt.Printf("Anime details: %+v\n", animeDetails)

	// 更新我的动漫列表状态
	_, _, err = c.Anime.UpdateMyListStatus(ctx, 967,
		mal.AnimeStatusWatching,
		mal.NumEpisodesWatched(73),
		mal.Score(8),
		mal.Comments("You wa shock!"),
		mal.StartDate(time.Date(2022, 02, 20, 0, 0, 0, 0, time.UTC)),
		mal.FinishDate(time.Time{}), // 移除现有日期
	)
	if err != nil {
		fmt.Printf("Error updating anime list: %v\n", err)
		return
	}
	fmt.Println("Successfully updated anime list")
}

更多功能

该库还支持以下功能：

• 获取用户动漫/漫画列表
• 获取动漫/漫画排名
• 删除列表项等

测试

运行单元测试：

go test -cover

运行集成测试：

go test --client-id='<your app client ID>' --oauth2-token='<your oauth2 token>'

许可证

MIT