49 releases (23 breaking)
new 0.24.0 | Nov 21, 2024 |
---|---|
0.22.0 | Sep 16, 2024 |
0.21.0 | May 6, 2024 |
0.19.1 | Mar 25, 2024 |
0.1.3 | Jul 29, 2022 |
#81 in Network programming
6,005 downloads per month
11MB
251K
SLoC
Azure DevOps Rust API
Overview
azure_devops_rust_api
implements a Rust interface to the Azure DevOps REST API (version 7.1).
The crate is autogenerated from the Azure DevOps OpenAPI spec.
The crate contains 38 modules
Usage
Usage overview
The crate has many features/modules, but the general approach is similar for all:
- Obtain an authentication credential
- See examples for how to do this using the
azure_identity
crate
- See examples for how to do this using the
- Create a client for the feature/module that you want to use
- Normally you need to create a client for the top-level module that you want to use,
(e.g.
git_client
), and then one for the submodule (e.g.repositories_client
).
- Normally you need to create a client for the top-level module that you want to use,
(e.g.
- Use the client to make operation requests
- Each operation has zero or more mandatory parameters and zero or more optional parameters.
Mandatory parameters are passed as parameters on the operation request method. Optional
parameters may be provided by calling methods on the "builder" object returned by the
operation request method. The builder object is finalized by invoking
await
, which transforms the builder into a Future (via theIntoFuture
trait) and awaits the response.
- Each operation has zero or more mandatory parameters and zero or more optional parameters.
Mandatory parameters are passed as parameters on the operation request method. Optional
parameters may be provided by calling methods on the "builder" object returned by the
operation request method. The builder object is finalized by invoking
Code example
Example usage (from examples/git_repo_list.rs):
// Get authentication credential either from a PAT ("ADO_TOKEN")
// or via the az cli.
let credential = utils::get_credential()
// Get ADO configuration via environment variables
let organization = env::var("ADO_ORGANIZATION")
.expect("Must define ADO_ORGANIZATION");
let project = env::var("ADO_PROJECT")
.expect("Must define ADO_PROJECT");
// Create a git client
let git_client = git::ClientBuilder::new(credential).build();
// Get all repositories in the specified organization/project
let repos = git_client
.repositories_client()
.list(organization, project)
.await?
.value;
// Output repo names
for repo in repos.iter() {
println!("{}", repo.name);
}
println!("{} repos found", repos.len());
Individual modules in the API are enabled via Rust features
.
See the features
section of Cargo.toml for the full list of features.
Example application Cargo.toml
dependency spec showing how to specify desired features:
[dependencies]
...
azure_devops_rust_api = { version = "0.23.0", features = ["git", "pipelines"] }
Examples
See examples directory.
Define environment variables:
export ADO_ORGANIZATION=<organization-name>
export ADO_PROJECT=<project-name>
To run the examples you need to provide authentication credentials either via:
- The
az
CLI, where you just need to have authenticated by runningaz login
before running the examples. - A Personal Access Token (PAT), provided via the environment variable
ADO_TOKEN
Note: A personal access token contains your security credentials for Azure DevOps. A PAT identifies you, your accessible organizations, and scopes of access. As such, they're as critical as passwords, so you should treat them the same way. When creating a PAT only grant it the minimum required scopes, and set the expiry time to be short.
Run the example via cargo run --example
. You will need to enable the features required
by the example. If you don't specify the necessary features you do get a helpful error
message.
Example:
cargo run --example git_repo_get --features="git" <repo-name>
Issue reporting
If you find any issues then please raise them via Github.
Useful links
Dependencies
~8–22MB
~306K SLoC