bpi_rs/web_widget/
header.rs

1//! B站首页头图相关接口
2//!
3//! [查看 API 文档](https://socialsisteryi.github.io/bilibili-API-collect/docs/web_widget/header.html)
4use serde::{Deserialize, Serialize};
5
6use crate::BpiError;
7
8/// B站首页头图数据
9#[derive(Debug, Clone, Deserialize, Serialize)]
10pub struct HeaderData {
11    /// 空
12    pub name: String,
13    /// 静态头图 URL
14    pub pic: String,
15    /// Bilibili logo URL
16    pub litpic: String,
17    /// 空
18    pub url: String,
19    /// 是否分层, 1: 是
20    pub is_split_layer: u32,
21    /// 分层信息，一个套在字符串里的 JSON 对象
22    pub split_layer: String,
23
24    #[serde(default, skip_serializing_if = "Option::is_none")]
25    pub split_layer_obj: Option<SplitLayer>,
26}
27
28impl HeaderData {
29    pub fn parse_split_layer(&mut self) -> Result<(), BpiError> {
30        let result = serde_json::from_str(&self.split_layer);
31        match result {
32            Ok(r) => {
33                self.split_layer_obj = Some(r);
34                Ok(())
35            }
36            Err(e) => Err(BpiError::parse(format!("解析split_layer失败: {:?}", e))),
37        }
38    }
39}
40
41/// 分层信息
42#[derive(Debug, Clone, Deserialize, Serialize)]
43pub struct SplitLayer {
44    /// 版本号
45    pub version: String,
46    /// 层信息
47    pub layers: Vec<Layer>,
48}
49#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
50#[serde(rename_all = "camelCase")]
51pub struct Layer {
52    pub resources: Vec<Resource>,
53    pub scale: Scale,
54    pub rotate: Rotate,
55    pub translate: Translate,
56    pub blur: Blur,
57    pub opacity: Opacity,
58    pub id: i64,
59    pub name: String,
60}
61
62#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
63#[serde(rename_all = "camelCase")]
64pub struct Resource {
65    pub src: String,
66    pub id: i64,
67}
68
69#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
70#[serde(rename_all = "camelCase")]
71pub struct Scale {
72    pub initial: Option<f64>,
73}
74
75#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
76#[serde(rename_all = "camelCase")]
77pub struct Rotate {
78    pub offset: Option<i64>,
79}
80
81#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
82#[serde(rename_all = "camelCase")]
83pub struct Translate {
84    pub offset: Option<Vec<i64>>,
85    pub initial: Option<Vec<i64>>,
86}
87
88#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
89#[serde(rename_all = "camelCase")]
90pub struct Blur {
91    pub initial: Option<i64>,
92}
93
94#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
95#[serde(rename_all = "camelCase")]
96pub struct Opacity {
97    pub wrap: String,
98    pub initial: Option<f64>,
99}
100
101#[cfg(test)]
102mod tests {
103    use super::*;
104    use crate::probe::contract::HttpMethod;
105    use crate::probe::endpoint_contract::EndpointContract;
106    use crate::web_widget::params::WebWidgetHeaderPageParams;
107    use crate::{ApiEnvelope, BpiClient, BpiResult};
108    use tracing::info;
109
110    fn contract() -> BpiResult<EndpointContract> {
111        EndpointContract::from_slice(include_bytes!(
112            "../../tests/contracts/web_widget/header-page/contract.json"
113        ))
114    }
115
116    #[ignore = "legacy live API test; requires explicit BPI_LIVE_TEST review"]
117    #[tokio::test]
118    async fn test_get_header_page() {
119        let bpi = BpiClient::new().expect("client should build");
120        let resp = bpi
121            .web_widget()
122            .header_page(WebWidgetHeaderPageParams::new())
123            .await;
124        info!("响应: {:?}", resp);
125        assert!(resp.is_ok());
126    }
127
128    #[test]
129    fn web_widget_header_page_contract_matches_endpoint_request() -> BpiResult<()> {
130        let contract = contract()?;
131
132        assert_eq!(contract.name, "web_widget.header_page");
133        assert_eq!(contract.request.method, HttpMethod::Get);
134        assert_eq!(
135            contract.request.url.as_str(),
136            "https://api.bilibili.com/x/web-show/page/header"
137        );
138        assert_eq!(
139            contract
140                .request
141                .query
142                .get("resource_id")
143                .map(String::as_str),
144            Some("142")
145        );
146        assert_eq!(contract.cases.len(), 3);
147        assert_eq!(
148            contract.cases[0].response.rust_model.as_deref(),
149            Some("HeaderData")
150        );
151        Ok(())
152    }
153
154    #[test]
155    fn web_widget_header_page_response_fixtures_parse_declared_model() -> BpiResult<()> {
156        for bytes in [
157            include_bytes!(
158                "../../tests/contracts/web_widget/header-page/responses/anonymous.success.json"
159            )
160            .as_slice(),
161            include_bytes!(
162                "../../tests/contracts/web_widget/header-page/responses/normal.success.json"
163            )
164            .as_slice(),
165            include_bytes!(
166                "../../tests/contracts/web_widget/header-page/responses/vip.success.json"
167            )
168            .as_slice(),
169        ] {
170            let mut payload = ApiEnvelope::<HeaderData>::from_slice(bytes)?.into_payload()?;
171
172            assert!(payload.split_layer_obj.is_none());
173            payload.parse_split_layer()?;
174            assert!(payload.split_layer_obj.is_some());
175        }
176        Ok(())
177    }
178
179    fn local_probe_body(profile: &str) -> Option<serde_json::Value> {
180        let path =
181            format!("target/bpi-probe-runs/web_widget/public/header-page/{profile}.response.json");
182        let bytes = std::fs::read(path).ok()?;
183        let value: serde_json::Value = serde_json::from_slice(&bytes).ok()?;
184        value
185            .get("response")
186            .and_then(|response| response.get("body"))
187            .cloned()
188    }
189
190    #[test]
191    fn web_widget_header_page_model_matches_local_probe_outputs_when_available() -> BpiResult<()> {
192        for profile in ["anonymous", "normal", "vip"] {
193            let Some(body) = local_probe_body(profile) else {
194                continue;
195            };
196            let mut payload =
197                serde_json::from_value::<ApiEnvelope<HeaderData>>(body)?.into_payload()?;
198
199            payload.parse_split_layer()?;
200            assert!(payload.split_layer_obj.is_some());
201        }
202        Ok(())
203    }
204}
bpi_rs/web_widget/header.rs

bpi_rs/web_widget/
header.rs
