Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/octokit/go-octokit
Simple Go wrapper for the GitHub API
https://github.com/octokit/go-octokit
octokit-go sdk
Last synced: 7 days ago
JSON representation
Simple Go wrapper for the GitHub API
- Host: GitHub
- URL: https://github.com/octokit/go-octokit
- Owner: octokit
- License: mit
- Archived: true
- Created: 2013-06-08T23:50:29.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-06-17T14:22:49.000Z (over 2 years ago)
- Last Synced: 2024-08-02T18:40:20.231Z (3 months ago)
- Topics: octokit-go, sdk
- Language: Go
- Homepage: https://github.com/octokit/go-octokit
- Size: 1.93 MB
- Stars: 258
- Watchers: 21
- Forks: 79
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# go-octokit [](https://travis-ci.org/octokit/go-octokit)
Go toolkit for the GitHub API.
## Status
This project is no longer maintained. If you are looking for a stable, well-maintained client for the GitHub API v3,
please consider [google/go-github](https://github.com/google/go-github). If you're interested in using the
GraphQL API v4, the recommended library is [shurcooL/githubv4](https://github.com/shurcooL/githubv4).
## Motivation
`go-octokit` is designed to be a hypermedia API client that [wraps](http://wynnnetherland.com/journal/what-makes-a-good-api-wrapper) the [GitHub API](http://developer.github.com/).
## Hypermedia Client
[HAL](http://tools.ietf.org/html/draft-kelly-json-hal) is a simple format that gives a consistent and easy way to hyperlink between resources in web API.
Being a client for HAL means it can navigate around the resources by following hyperlinks.
`go-octokit` is a hypermedia client for the GitHub API that it can traverse links by following the GitHub API conventions.
Under the hood, it uses [`go-sawyer`](https://github.com/lostisland/go-sawyer), the Go version of the [Ruby Sawyer](https://github.com/lostisland/sawyer).
### Resource Objects
Resources in `go-octokit` contain not only data but hyperlinks:
```go
package main
import "github.com/octokit/go-octokit/octokit"
func main() {
client := octokit.NewClient(nil)
url, err := octokit.UserURL.Expand(octokit.M{"user": "jingweno"})
if err != nil {
// Handle error
}
user, result := client.Users(url).One()
if result.HasError() {
// Handle error
}
fmt.Println(user.ReposURL) // https://api.github.com/users/jingweno/repos
}
```
### URI templates
Many hypermedia links have variable placeholders. `go-octokit` supports [URI Templates](http://tools.ietf.org/html/rfc6570) for parameterized URI expansion:
```go
package main
import "github.com/octokit/go-octokit/octokit"
func main() {
url, _ := octokit.UserURL.Expand(octokit.M{"user": "jingweno"})
fmt.Println(url) // https://api.github.com/users/jingweno
}
```
### API Discoverability
If you want to use `go-octokit` as a pure hypermedia API client, you can
start at the API root and follow hypermedia links which drive the application state transitions:
```go
package main
import "github.com/octokit/go-octokit/octokit"
func main() {
rootURL, _ := client.RootURL.Expand(nil)
root, _ := client.Root(rootURL).One()
userURL, _ := root.UserURL.Expand(octokit.M{"users": "jingweno"})
user, _ := client.Users(userURL).One()
}
```
### Pagination
```go
package main
import "github.com/octokit/go-octokit/octokit"
func main() {
url, err := octokit.UserURL.Expand(nil)
if err != nil {
// Handle error
}
users, result := client.Users(url).All()
if result.HasError() {
// Handle error
}
// Do something with users
// Next page
nextPageURL, _ := result.NextPage.Expand(nil)
users, result := client.Users(nextPageURL).All()
if result.HasError() {
// Handle error
}
// Do something with users
}
```
### Caching
Client-side caching is the #1 thing to do to make a hypermedia client more performant.
We plan to support this in the near future.
More [examples](https://github.com/octokit/go-octokit/blob/master/examples/example.go) are available.
## Release Notes
See [Releases](https://github.com/octokit/go-octokit/releases).
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## License
go-octokit is released under the MIT license. See
[LICENSE](https://github.com/octokit/go-octokit/blob/master/LICENSE).