Crates.io | octocrab |
lib.rs | octocrab |
version | 0.38.0 |
source | src |
created_at | 2020-04-12 23:07:07.699909 |
updated_at | 2024-04-09 10:50:01.5217 |
description | A modern, extensible GitHub API client. |
homepage | https://github.com/XAMPPRocky/octocrab |
repository | https://github.com/XAMPPRocky/octocrab.git |
max_upload_size | |
id | 229484 |
size | 2,662,585 |
Octocrab is a third party GitHub API client, allowing you to easily build
your own GitHub integrations or bots in Rust. Octocrab
comes with two primary
sets of APIs for communicating with GitHub, a high level strongly typed
semantic API, and a lower level HTTP API for extending behaviour.
Run this command in your terminal to add the latest version of Octocrab
.
cargo add octocrab
The semantic API provides strong typing around GitHub's API, a set of
models
that maps to GitHub's types, and auth
functions that are useful
for GitHub apps.
Currently, the following modules are available as of version 0.17
.
actions
GitHub Actions.apps
GitHub Apps.current
Information about the current user.gitignore
Gitignore templates.graphql
GraphQL.issues
Issues and related items, e.g. comments, labels, etc.licenses
License Metadata.markdown
Rendering Markdown with GitHub.orgs
GitHub Organisations.pulls
Pull Requests.releases
Releases.repos
Repositories.search
GitHub's search API.teams
Teams.gists
GitHub's gists APIusers
Users.// Get pull request #5 from `XAMPPRocky/octocrab`.
let issue = octocrab::instance().pulls("XAMPPRocky", "octocrab").get(5).await?;
All methods with multiple optional parameters are built as Builder
structs, allowing you to easily specify parameters.
let octocrab = octocrab::instance();
// Returns the first page of all issues.
let mut page = octocrab
.issues("XAMPPRocky", "octocrab")
.list()
// Optional Parameters
.creator("XAMPPRocky")
.state(params::State::All)
.per_page(50)
.send()
.await?;
// Go through every page of issues. Warning: There's no rate limiting so
// be careful.
loop {
for issue in &page {
println!("{}", issue.title);
}
page = match octocrab
.get_page::<models::issues::Issue>(&page.next)
.await?
{
Some(next_page) => next_page,
None => break,
}
}
The typed API currently doesn't cover all of GitHub's API at this time, and
even if it did GitHub is in active development and this library will
likely always be somewhat behind GitHub at some points in time. However that
shouldn't mean that in order to use those features, you have to fork
or replace octocrab
with your own solution.
Instead octocrab
exposes a suite of HTTP methods allowing you to easily
extend Octocrab
's existing behaviour. Using these HTTP methods allows you
to keep using the same authentication and configuration, while having
control over the request and response. There is a method for each HTTP
method, get
, post
, patch
, put
, delete
, all of which accept a
relative route and a optional body.
let user: octocrab::models::User = octocrab::instance()
.get("/user", None::<&()>)
.await?;
Each of the HTTP methods expects a body, formats the URL with the base
URL, and errors if GitHub doesn't return a successful status, but this isn't
always desired when working with GitHub's API, sometimes you need to check
the response status or headers. As such there are companion methods _get
,
_post
, etc. that perform no additional pre or post-processing to
the request.
let octocrab = octocrab::instance();
let response = octocrab
._get("https://api.github.com/organizations")
.await?;
// You can also use `Uri::builder().authority("<my custom base>").path_and_query("<my custom path>")` if you want to customize the base uri and path.
let response = octocrab
._get(Uri::builder().path_and_query("/organizations").build().expect("valid uri"))
.await?;
You can use the those HTTP methods to easily create your own extensions to
Octocrab
's typed API. (Requires async_trait
).
use octocrab::{Octocrab, Page, Result, models};
#[async_trait::async_trait]
trait OrganisationExt {
async fn list_every_organisation(&self) -> Result<Page<models::Organization>>;
}
#[async_trait::async_trait]
impl OrganisationExt for Octocrab {
async fn list_every_organisation(&self) -> Result<Page<models::Organization>> {
self.get("/organizations", None::<&()>).await
}
}
You can also easily access new properties that aren't available in the
current models using serde
.
#[derive(Deserialize)]
struct RepositoryWithVisibility {
#[serde(flatten)]
inner: octocrab::models::Repository,
visibility: String,
}
let my_repo = octocrab::instance()
.get::<RepositoryWithVisibility>("https://api.github.com/repos/XAMPPRocky/octocrab", None::<&()>)
.await?;
Octocrab
also provides a statically reference counted version of its API,
allowing you to easily plug it into existing systems without worrying
about having to integrate and pass around the client.
// Initialises the static instance with your configuration and returns an
// instance of the client.
octocrab::initialise(octocrab::Octocrab::builder());
// Gets a instance of `Octocrab` from the static API. If you call this
// without first calling `octocrab::initialise` a default client will be
// initialised and returned instead.
let octocrab = octocrab::instance();