Struct BacklogClient 

pub struct BacklogClient { /* private fields */ }

Backlog client with API key authentication

Implementations

impl BacklogClient

pub fn new<S: Into<String>>(base_url: S, api_key: S) -> Self

Create a new Backlog client with API key authentication

Arguments

• base_url - The base URL of your Backlog instance (e.g., “https://yourspace.backlog.com” or “https://yourspace.backlogtool.com”)
• api_key - Your Backlog API key

Example

use backlog_client::BacklogClient;

let client = BacklogClient::new("https://yourspace.backlog.com", "your_api_key");

Examples found in repository

examples/get_space.rs (line 15)

async fn main() -> BacklogResult<()> {
    dotenv().ok();
    let base_url = env::var("BACKLOG_BASE_URL")
        .expect("BACKLOG_BASE_URL environment variable must be set in .env file");
    let api_key = env::var("BACKLOG_API_KEY")
        .expect("BACKLOG_API_KEY environment variable must be set in .env file");

    println!("Connecting to: {}", base_url);

    let client = BacklogClient::new(&base_url, &api_key);

    println!("executing...");
    match client.get_space().await {
        Ok(space) => {
            println!("{:?}", space);
        }
        Err(e) => println!("Error getting space: {:?}", e),
    }

    Ok(())
}

pub fn with_client<S: Into<String>>( base_url: S, api_key: S, client: Client, ) -> Self

Create a new Backlog client with custom reqwest client

pub async fn get(&self, endpoint: &str) -> BacklogResult<Response>

Make a GET request to the Backlog API

pub async fn post<T: Serialize>( &self, endpoint: &str, body: &T, ) -> BacklogResult<Response>

Make a POST request to the Backlog API

pub async fn put<T: Serialize>( &self, endpoint: &str, body: &T, ) -> BacklogResult<Response>

Make a PUT request to the Backlog API

pub async fn patch<T: Serialize>( &self, endpoint: &str, body: &T, ) -> BacklogResult<Response>

Make a PATCH request to the Backlog API

pub async fn delete(&self, endpoint: &str) -> BacklogResult<Response>

Make a DELETE request to the Backlog API

pub async fn get_json<T: for<'de> Deserialize<'de>>( &self, endpoint: &str, ) -> BacklogResult<T>

Get JSON response from endpoint

pub async fn post_json<T: Serialize, R: for<'de> Deserialize<'de>>( &self, endpoint: &str, body: &T, ) -> BacklogResult<R>

Post JSON and get JSON response

impl BacklogClient

pub async fn get_space(&self) -> BacklogResult<Space>

Get space information

Examples found in repository

examples/get_space.rs (line 18)

async fn main() -> BacklogResult<()> {
    dotenv().ok();
    let base_url = env::var("BACKLOG_BASE_URL")
        .expect("BACKLOG_BASE_URL environment variable must be set in .env file");
    let api_key = env::var("BACKLOG_API_KEY")
        .expect("BACKLOG_API_KEY environment variable must be set in .env file");

    println!("Connecting to: {}", base_url);

    let client = BacklogClient::new(&base_url, &api_key);

    println!("executing...");
    match client.get_space().await {
        Ok(space) => {
            println!("{:?}", space);
        }
        Err(e) => println!("Error getting space: {:?}", e),
    }

    Ok(())
}

Trait Implementations

impl Clone for BacklogClient

fn clone(&self) -> BacklogClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.