1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
# MAL2Go/anime
MAL2Go `anime` package has functionality related to getting data about anime.
To *update* anime status (score, status, etc) refer to [`user/anime`](../user/anime) package.
## Usage
Firstly, import this package and instanciate the client.
``` go
import (
"github.com/MikunoNaka/MAL2Go/anime"
)
```
Now instanciate with
``` go
myClient := anime.Client {
AuthToken: "Bearer " + yourTokenHere,
}
```
- ### Searching for an anime
``` go
searchString := "mushishi" // your search string here
// max amount of results to pull. Max is 500
limit := 10
// if the offset is 2 it will skip the first 2 results, then pull the next 10
offset := 0
// the API by default only returns some basic data
// you can specify some fields as a []string slice.
// it will return the default fields even if they aren't specified
fields := []string{
"id", "title", "main_picture",
"alternative_titles", "start_date",
"end_date", "synopsis", "mean", "rank",
"popularity", "num_list_users",
"num_scoring_users", "nsfw", "created_at",
"updated_at", "media_type", "status",
"genres", "my_list_status", "num_episodes",
"start_season", "broadcast", "source",
"average_episode_duration", "rating",
"pictures", "background", "related_anime",
"related_manga", "recommendations",
"studios", "statistics",
} // for all default fields fields := []string{} will also work
// finally making the API request
searchResults, err := myClient.SearchAnime(searchString, limit, offset, fields)
fmt.Println(searchResults.Animes) // print list of the search results
// results have page numbers
fmt.Println(searchResults.ListPaging.NextPage, searchResults.ListPaging.PrevPage)
```
**More to be added later**
## Structure
- [anime.go](anime.go)
Contains all the exported functions for pulling data from the API.
- [anime.structs.go](anime.structs.go)
Contains all the structs representing an anime entry on MyAnimeList.
- [client.go](client.go)
The Client for accessing the API with this package.
- [general.structs.go](general.structs.go)
Some structs that can't particularly be grouped with another file.
- [ranking.structs.go](ranking.structs.go)
Representing anime ranking data both in the form returned by the API and
the formatted form to be returned by this package.
- [request_handler.go](request_handler.go)
Responsible for making HTTP requests
- [search.structs.go](search.structs.go)
Representing search results.
- [seasonal.structs.go](seasonal.structs.go)
Representing seasonal anime list.
- [suggestedanime.structs.go](suggestedanime.structs.go)
Representing suggested anime data.
|
