Struct BackstageClient 

pub struct BackstageClient { /* private fields */ }

A client for interacting with the Backstage API.

Implementations

impl BackstageClient

pub fn new(base_url: &str, token: &str) -> Result<Self>

Creates a new instance of the Backstage client.

Arguments

• base_url - The base URL of the Backstage API.
• token - The authentication token for accessing the API.

Returns

A new instance of BackstageClient.

Errors

Returns ClientError::InvalidUrl if the base URL is invalid.

pub async fn fetch_entities<T: DeserializeOwned>( &self, filters: Option<HashMap<String, String>>, ) -> Result<Vec<T>>

Fetches entities from the Backstage API based on filters.

Arguments

• filters - Optional filters to apply to the request.

Returns

A Result containing a vector of entities or a ClientError.

Examples

use backstage_client::{BackstageClient, entities::Entity};
use std::collections::HashMap;

let client = BackstageClient::new("https://backstage.example.com", "token")?;

// Fetch all entities
let entities = client.fetch_entities::<Entity>(None).await?;

// Fetch only components
let mut filters = HashMap::new();
filters.insert("kind".to_string(), "Component".to_string());
let components = client.fetch_entities::<Entity>(Some(filters)).await?;

pub async fn get_entity<T: DeserializeOwned>( &self, kind: &str, namespace: Option<&str>, name: &str, ) -> Result<T>

Gets a specific entity by its compound key.

Arguments

• kind - The kind of entity (e.g., “Component”, “API”).
• namespace - The namespace of the entity (optional, defaults to “default”).
• name - The name of the entity.

Returns

A Result containing the entity or a ClientError.

Trait Implementations

impl Debug for BackstageClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.