Expand description
Clients for GitHub API.
Generated from https://github.com/github/rest-api-description/commits/main/descriptions/api.github.com/api.github.com.json SHA 6985b0b dated 27 April 2022
§HTTP library support
The underlying web library can be selected as a feature.
For hyper
, the feature hyper-client
is enabled by default.
For async reqwest
use
[dependencies]
jinxapi-github = { version = "0.1", default-features = false, features = ["reqwest-async"] }
For blocking reqwest
use
[dependencies]
jinxapi-github = { version = "0.1", default-features = false, features = ["reqwest-blocking"] }
§Using the API
Broadly, the steps to use the API are:
- Create a
v1_1_4::config::Configuration
object, including authentication credentials. - Create a client for the underlying HTTP library (
hyper
orreqwest
). - Create a
Caller
(v1_1_4::hyper::Caller
,v1_1_4::reqwest::Caller
,v1_1_4::reqwest::blocking::Caller
), providing theConfiguration
, Client, and an appropriate function for sleeping (e.g.std::thread::sleep
ortokio::time::sleep
). - For requests with a body, create the body type.
- Call a method on the
Caller
, passing in operation parameters and, if required, a body. - Handle the response returned from the method.
Modules§
- GitHub v3 REST API