使用Golang访问GitHub REST API v3

GitHub提供了完善的REST API v3接口，在Golang中有几个优秀的库可以帮助我们更方便地与GitHub API交互。下面我将介绍几个主流的Golang GitHub API库及其使用方法。

1. go-github官方库

GitHub官方维护的Golang客户端库是最权威的选择：

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/google/go-github/v58/github"
	"golang.org/x/oauth2"
)

func main() {
	// 创建认证客户端
	ctx := context.Background()
	ts := oauth2.StaticTokenSource(
		&oauth2.Token{AccessToken: "your-github-access-token"},
	)
	tc := oauth2.NewClient(ctx, ts)
	client := github.NewClient(tc)

	// 获取用户信息
	user, _, err := client.Users.Get(ctx, "")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Logged in as: %s\n", *user.Login)

	// 创建仓库
	repo := &github.Repository{
		Name:    github.String("my-new-repo"),
		Private: github.Bool(false),
	}
	newRepo, _, err := client.Repositories.Create(ctx, "", repo)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Created repo: %s\n", *newRepo.HTMLURL)
}

2. shurcooL/githubv4

如果你需要使用GitHub GraphQL API v4，可以使用这个库：

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/shurcooL/githubv4"
	"golang.org/x/oauth2"
)

func main() {
	src := oauth2.StaticTokenSource(
		&oauth2.Token{AccessToken: os.Getenv("GITHUB_TOKEN")},
	)
	httpClient := oauth2.NewClient(context.Background(), src)
	client := githubv4.NewClient(httpClient)

	var query struct {
		Viewer struct {
			Login     githubv4.String
			CreatedAt githubv4.DateTime
		}
	}

	err := client.Query(context.Background(), &query, nil)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("Login:", query.Viewer.Login)
	fmt.Println("Created at:", query.Viewer.CreatedAt)
}

3. 其他实用库

3.1 认证库

// 使用golang.org/x/oauth2进行OAuth认证
func getOAuthClient() *http.Client {
	conf := &oauth2.Config{
		ClientID:     "your-client-id",
		ClientSecret: "your-client-secret",
		Scopes:       []string{"repo", "user"},
		Endpoint:     github.Endpoint,
	}
	
	// 重定向用户到GitHub授权页面
	url := conf.AuthCodeURL("state", oauth2.AccessTypeOnline)
	fmt.Printf("Visit the URL for the auth dialog: %v", url)

	// 使用授权码获取token
	var code string
	if _, err := fmt.Scan(&code); err != nil {
		log.Fatal(err)
	}
	
	tok, err := conf.Exchange(context.Background(), code)
	if err != nil {
		log.Fatal(err)
	}
	
	return conf.Client(context.Background(), tok)
}

3.2 处理Webhooks

package main

import (
	"fmt"
	"log"
	"net/http"

	"github.com/go-playground/webhooks/v6/github"
)

func main() {
	hook, _ := github.New(github.Options.Secret("your-github-webhook-secret"))

	http.HandleFunc("/webhooks", func(w http.ResponseWriter, r *http.Request) {
		payload, err := hook.Parse(r, github.PushEvent, github.PullRequestEvent)
		if err != nil {
			if err == github.ErrEventNotFound {
				// 事件类型未处理
			}
		}
		switch payload.(type) {
		case github.PushPayload:
			push := payload.(github.PushPayload)
			fmt.Printf("%+v", push)
		case github.PullRequestPayload:
			pullRequest := payload.(github.PullRequestPayload)
			fmt.Printf("%+v", pullRequest)
		}
	})
	log.Fatal(http.ListenAndServe(":3000", nil))
}

最佳实践

1. 认证方式：

   • 个人访问令牌(PAT)适合脚本和自动化
   • OAuth适合需要用户授权的应用
   • GitHub App适合集成场景

2. 错误处理：

   _, resp, err := client.Repositories.Get(ctx, "owner", "repo")
   if err != nil {
       if ghErr, ok := err.(*github.ErrorResponse); ok {
           log.Printf("GitHub API error: %v", ghErr.Message)
       }
       log.Fatal(err)
   }
   

3. 分页处理：

   opt := &github.RepositoryListOptions{
       ListOptions: github.ListOptions{PerPage: 50},
   }
   
   var allRepos []*github.Repository
   for {
       repos, resp, err := client.Repositories.List(ctx, "", opt)
       if err != nil {
           log.Fatal(err)
       }
       allRepos = append(allRepos, repos...)
       if resp.NextPage == 0 {
           break
       }
       opt.Page = resp.NextPage
   }
   

4. 速率限制处理：

   rate, _, err := client.RateLimits(ctx)
   if err != nil {
       log.Fatal(err)
   }
   fmt.Printf("Rate limit: %d/%d (resets at %v)\n", 
       rate.Core.Remaining, rate.Core.Limit, rate.Core.Reset)
   

这些库和示例代码应该能帮助你开始在Golang中与GitHub API进行交互。根据你的具体需求选择合适的库和方法。