Go
本頁譯自英文。如兩者有出入,以英文頁面為準。 閱讀英文頁面
Go 函式庫是 lingara 套件,位於模組 github.com/Spinning-Cat-Studios/lingara_api_clients/go 中。它需要 Go 1.23 或更新版本,而且只使用標準函式庫。
使用方式
- 每個呼叫的第一個參數都是
context.Context。取消該 context 即可取消呼叫;你收到的錯誤就是 context 本身的錯誤,所以errors.Is(err, context.Canceled)能正常運作。 - 呼叫是同步的。想同時發出多個呼叫時,就在 goroutine 中執行它們;一個用戶端可以安全地共用。
- 串流以
for ev, err := range s.Events()讀取,每個事件用 type switch 比對。用defer s.Close()關閉它。 - 錯誤分為四種型別,它們共用
lingara.Error介面。用errors.As取得其中一種;當 API 沒有指定等待時間時,RetryAfter為nil。 - 選項採用函式式寫法:傳入
lingara.WithHTTPClient即可使用你自己的http.Client。這樣它的Timeout就會限制每一個呼叫,包括串流在內。
下面的範例會安裝模組、建立用戶端、以串流方式取得詞彙清單並處理錯誤。
Go
go get github.com/Spinning-Cat-Studios/lingara_api_clients/go@v0.1.0-alpha.6Go
import (
"os"
lingara "github.com/Spinning-Cat-Studios/lingara_api_clients/go"
)
client, err := lingara.New(
lingara.WithClientCredentials(os.Getenv("LINGARA_CLIENT_ID"), os.Getenv("LINGARA_CLIENT_SECRET")),
)
if err != nil {
return nil, err
}Go
count := uint8(8)
s, err := client.GenerateVocabulary(ctx, lingara.VocabRequest{Level: 2, SourceLang: "en", TargetLang: "zh", Count: &count})
if err != nil {
return err
}
defer s.Close()
for ev, err := range s.Events() {
if err != nil {
return err
}
if item, ok := ev.(lingara.GenerateVocabularyEventItem); ok {
fmt.Println(item.Data.Word, item.Data.Translation)
}
}Go
_, err := client.GetUsage(ctx)
var apiErr *lingara.APIError
var oauthErr *lingara.OAuthError
var maintenance *lingara.MaintenanceError
var transport *lingara.TransportError
switch {
case err == nil:
case errors.As(err, &apiErr):
// A refusal from the API: Status, Code (stable) and Message (localised).
fmt.Println(apiErr.Status, apiErr.Code, apiErr.Message)
if apiErr.RetryAfter != nil {
fmt.Println("retry after", *apiErr.RetryAfter)
}
case errors.As(err, &oauthErr):
// The token endpoint refused the credentials or the scopes.
fmt.Println(oauthErr.Status, oauthErr.ErrorCode, oauthErr.Description)
case errors.As(err, &maintenance):
fmt.Println("under maintenance")
if maintenance.RetryAfter != nil {
fmt.Println("retry after", *maintenance.RetryAfter)
}
case errors.As(err, &transport):
// No usable answer: connect, tls, reset, timeout, and so on.
fmt.Println("transport:", transport.Kind)
default:
// ctx was cancelled or timed out: errors.Is(err, context.Canceled).
fmt.Println(err)
}