Struct RestApiAdapter 

pub struct RestApiAdapter { /* private fields */ }

REST API scraping adapter.

Thread-safe and cheaply cloneable — the inner reqwest::Client uses Arc internally. Build once, share across tasks.

Example

use stygian_graph::adapters::rest_api::RestApiAdapter;

let adapter = RestApiAdapter::new();

Implementations

impl RestApiAdapter

pub fn new() -> Self

Create a new adapter with default configuration.

Example

use stygian_graph::adapters::rest_api::RestApiAdapter;
let adapter = RestApiAdapter::new();

pub fn with_config(config: RestApiConfig) -> Self

Create an adapter with custom configuration.

Panics

Panics only if TLS is unavailable on the host (extremely rare).

Example

use stygian_graph::adapters::rest_api::{RestApiAdapter, RestApiConfig};
use std::time::Duration;

let adapter = RestApiAdapter::with_config(RestApiConfig {
    timeout: Duration::from_secs(10),
    ..Default::default()
});

pub fn extract_path<'a>(value: &'a Value, path: &str) -> Option<&'a Value>

Resolve a dot-separated path into a JSON Value.

Returns None if any path segment is missing.

Example

use serde_json::json;
use stygian_graph::adapters::rest_api::RestApiAdapter;

let v = json!({"meta": {"next": "abc123"}});
assert_eq!(
    RestApiAdapter::extract_path(&v, "meta.next"),
    Some(&json!("abc123"))
);
assert!(RestApiAdapter::extract_path(&v, "meta.gone").is_none());

pub fn parse_link_next(link_header: &str) -> Option<String>

Parse an RFC 8288 Link header and return the rel="next" URL, if any.

Example

use stygian_graph::adapters::rest_api::RestApiAdapter;

let link = r#"<https://api.example.com/items?page=2>; rel="next", <https://api.example.com/items?page=1>; rel="prev""#;
assert_eq!(
    RestApiAdapter::parse_link_next(link),
    Some("https://api.example.com/items?page=2".to_owned())
);

Trait Implementations

impl Clone for RestApiAdapter

fn clone(&self) -> RestApiAdapter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for RestApiAdapter

fn default() -> Self

Returns the “default value” for a type.

impl ScrapingService for RestApiAdapter

fn execute<'life0, 'async_trait>( &'life0 self, input: ServiceInput, ) -> Pin<Box<dyn Future<Output = Result<ServiceOutput>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute one or more REST API requests and return the aggregated result.

ServiceInput.url

Base URL of the REST endpoint (including path; query string is optional).

ServiceInput.params contract

{
  "method":   "GET",
  "body":     { "key": "value" },
  "body_raw": "raw body string",
  "headers":  { "X-Custom-Header": "value" },
  "query":    { "state": "open", "per_page": "30" },
  "accept":   "application/json",

  "auth": {
    "type":     "bearer",
    "token":    "...",
    "username": "user",
    "password": "pass",
    "header":   "X-Api-Key",
    "param":    "api_key",
    "key":      "sk-..."
  },

  "response": {
    "data_path":        "items",
    "collect_as_array": true
  },

  "pagination": {
    "strategy":        "link_header",
    "max_pages":       10,
    "page_param":      "page",
    "page_size_param": "per_page",
    "page_size":       100,
    "start_page":      1,
    "cursor_param":    "cursor",
    "cursor_field":    "meta.next_cursor"
  }
}

Auth type values

type	Required fields	Description
"bearer" / "oauth2"	token	Authorization: Bearer <token>
"basic"	username, password	HTTP Basic
"api_key_header"	header, key	Custom header
"api_key_query"	param, key	Query string
"none" or absent	—	No auth

Pagination strategies

strategy	Description
"none"	Single request (default)
"offset"	Increment page_param from start_page
"cursor"	Extract next cursor at cursor_field in each response; pass it as cursor_param
"link_header"	Follow RFC 8288 Link: <url>; rel="next" header

fn name(&self) -> &'static str

Service name for identification in logs and metrics