minigh

Crates.iominigh
lib.rsminigh
version0.1.1
created_at2025-06-08 18:20:12.507151+00
updated_at2025-06-27 11:05:26.563476+00
descriptionMinimal and opinionated GitHub REST API client
homepage
repositoryhttps://github.com/jwodder/minigh
max_upload_size
id1705134
size92,123
John T. Wodder II (jwodder)

documentation

README

Project Status: Active – The project has reached a stable, usable state and is being actively developed. CI Status Minimum Supported Rust Version MIT License

GitHub | crates.io | Documentation | Issues | Changelog

minigh is a thin wrapper around ureq for interacting with the GitHub REST API that aims to make common operations easier & simpler. Notable features include:

  • When making a request, you only need to specify the part of the URL after the API base URL.

  • Support for iterating over paginated results

  • Most request methods return decoded JSON.

  • Bring Your Own Schema: minigh does not define any types for values returned by the API; that is left up to the user.

  • Errors raised for 4xx and 5xx responses include the body of the response in the error value, and this body is included when displaying with {:#}.

  • The Accept and X-GitHub-Api-Version headers are automatically set to their recommended values.

  • Follows GitHub's recommendations for dealing with rate limits, including waiting between mutating requests and waiting & retrying in response to rate-limit errors

  • Automatic retrying on 5xx errors with exponential backoff

Commit count: 41

cargo fmt