bpi-rs 0.1.3

Bilibili API client library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! IP 地址归属地查询 API
//!
//! [参考文档](https://github.com/Yuelioi/bilibili-API-collect/tree/cfc5fddcc8a94b74d91970bb5b4eaeb349addc47/docs/clientinfo/ip.md)

use crate::{ BilibiliRequest, BpiClient, BpiError, BpiResponse };
use serde::{ Deserialize, Serialize };

// ==========================
// 数据结构
// ==========================

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct IpInfo {
    /// 国家
    pub country: Option<String>,
    /// 省份
    pub province: Option<String>,
    /// 城市
    pub city: Option<String>,
    /// ISP 运营商
    pub isp: Option<String>,
    /// IP 地址
    pub addr: Option<String>,
}

// ==========================
// API 封装
// ==========================

impl BpiClient {
    /// 查询 IP 地址归属地
    ///
    /// 查询指定 IP 地址的地理位置信息，包括国家、省份、城市和 ISP 运营商。
    /// 如果不提供 IP 参数，将返回请求方 IP 的地理信息。
    ///
    /// # 参数
    /// | 名称 | 类型 | 说明 |
    /// | ---- | ---- | ---- |
    /// | `ip` | `Option<&str>` | IPv4 或 IPv6 地址，可选。如果留空，返回请求方 IP 信息 |
    ///
    /// # 文档
    /// [IP 地址归属地查询](https://github.com/Yuelioi/bilibili-API-collect/tree/cfc5fddcc8a94b74d91970bb5b4eaeb349addc47/docs/clientinfo/ip.md)
    pub async fn clientinfo_ip(&self, ip: Option<&str>) -> Result<BpiResponse<IpInfo>, BpiError> {
        let mut req = self.get(
            "https://api.live.bilibili.com/ip_service/v1/ip_service/get_ip_addr"
        );

        if let Some(ip) = ip {
            req = req.query(&[("ip", ip)]);
        }

        req.send_bpi("查询 IP 地址归属地").await
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    const TEST_IP: &str = "8.8.8.8";

    #[tokio::test]
    async fn test_clientinfo_ip() -> Result<(), Box<BpiError>> {
        let bpi = BpiClient::new();

        let resp = bpi.clientinfo_ip(Some(TEST_IP)).await?;
        if resp.code == 0 {
            if let Some(data) = resp.data {
                tracing::info!(
                    "IP 地址: {}, 省份: {:?}, 城市: {:?}, ISP: {:?}",
                    data.addr.unwrap_or_default(),
                    data.province,
                    data.city,
                    data.isp
                );
            }
        } else {
            tracing::error!("请求失败: code={}, message={}", resp.code, resp.message);
        }

        Ok(())
    }
}