Struct APIRequestContext 

pub struct APIRequestContext { /* private fields */ }

Context for making API requests.

APIRequestContext can be created standalone or from a browser context. When created from a browser context, cookies are shared between the two.

Creating a Standalone Context

use viewpoint_core::api::{APIRequestContext, APIContextOptions};

let api = APIRequestContext::new(
    APIContextOptions::new()
        .base_url("https://api.example.com")
).await?;

// Make requests
let response = api.get("/users").send().await?;

Creating from Browser Context

use viewpoint_core::Browser;

let browser = Browser::launch().headless(true).launch().await.unwrap();
let context = browser.new_context().await.unwrap();

// Get API context that shares cookies with browser
let api = context.request().await.unwrap();

// API requests will include browser cookies
let response = api.get("https://httpbin.org/get").send().await.unwrap();

Implementations

impl APIRequestContext

pub async fn new(options: APIContextOptions) -> Result<Self, APIError>

Create a new standalone API request context.

Arguments

• options - Configuration options for the context

Errors

Returns an error if the HTTP client cannot be created.

pub fn get(&self, url: impl Into<String>) -> APIRequestBuilder

Create a GET request builder.

Example

let response = api.get("https://api.example.com/users")
    .query(&[("page", "1")])
    .send()
    .await?;

pub fn post(&self, url: impl Into<String>) -> APIRequestBuilder

Create a POST request builder.

Example

let response = api.post("https://api.example.com/users")
    .json(&serde_json::json!({"name": "John"}))
    .send()
    .await?;

pub fn put(&self, url: impl Into<String>) -> APIRequestBuilder

Create a PUT request builder.

Example

let response = api.put("https://api.example.com/users/1")
    .json(&serde_json::json!({"name": "John Updated"}))
    .send()
    .await?;

pub fn patch(&self, url: impl Into<String>) -> APIRequestBuilder

Create a PATCH request builder.

Example

let response = api.patch("https://api.example.com/users/1")
    .json(&serde_json::json!({"status": "active"}))
    .send()
    .await?;

pub fn delete(&self, url: impl Into<String>) -> APIRequestBuilder

Create a DELETE request builder.

Example

let response = api.delete("https://api.example.com/users/1")
    .send()
    .await?;

pub fn head(&self, url: impl Into<String>) -> APIRequestBuilder

Create a HEAD request builder.

Example

let response = api.head("https://api.example.com/users")
    .send()
    .await?;
println!("Content-Length: {:?}", response.header("content-length"));

pub fn fetch( &self, method: HttpMethod, url: impl Into<String>, ) -> APIRequestBuilder

Create a request builder with a specific HTTP method.

This is the underlying method used by get(), post(), etc.

Example

let response = api.fetch(HttpMethod::Get, "https://api.example.com/users")
    .send()
    .await?;

pub async fn dispose(&self)

Dispose of this API context, releasing resources.

After calling this method, any new requests will fail with APIError::Disposed.

Example

let api = APIRequestContext::new(APIContextOptions::new()).await?;
// ... use the API ...
api.dispose().await;

pub fn is_disposed(&self) -> bool

Check if this context has been disposed.

pub fn base_url(&self) -> Option<&str>

Get the base URL for this context.

pub fn cookie_jar(&self) -> &Arc<Jar>

Get access to the cookie jar.

This can be used to inspect or manually add cookies.

Trait Implementations

impl Clone for APIRequestContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for APIRequestContext

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

Formats the value using the given formatter.