Rocket Analytics

一个轻量级的 API 分析解决方案，包括仪表板。

入门指南

1. 生成 API 密钥

访问 https://apianalytics.dev/generate 以一键生成您独特的 API 密钥。此密钥用于监控您的 API 服务器，应私下存储。它也是查看您的 API 分析仪表板和数据所必需的。

2. 将中间件添加到您的 API

将我们的轻量级中间件添加到您的 API。几乎所有的处理都由我们的服务器处理，因此对您的 API 性能的影响最小。

cargo add rocket-analytics

#[macro_use]
extern crate rocket;
use rocket::serde::json::Json;
use rocket_analytics::Analytics;
use serde::Serialize;

#[derive(Serialize)]
pub struct JsonData {
    message: String,
}

#[get("/")]
fn root() -> Json<JsonData> {
    let data = JsonData {
        message: "Hello World".to_string(),
    };
    Json(data)
}

#[launch]
fn rocket() -> _ {
    rocket::build()
        .mount("/", routes![root])
        .attach(Analytics::new(<API-KEY>))
}

3. 查看您的分析

您的 API 现在将记录并存储所有有效路由上的传入请求数据。您可以使用以下两种方法查看记录的数据

1. 通过我们的仪表板上的可视化统计
2. 直接通过我们的数据 API

您可以在多个 API 中使用相同的 API 密钥，但所有数据都将显示在同一个仪表板上。我们建议为每个需要分析的其他 API 服务器生成一个新的 API 密钥。

仪表板

访问 https://apianalytics.dev/dashboard 并粘贴您的 API 密钥以访问您的仪表板。

演示: https://apianalytics.dev/dashboard/demo

数据 API

所有请求的记录数据都可以通过我们的 REST API 访问。只需在头部设置您的 API 密钥为 https://apianalytics-server.com/api/data 并发送一个 GET 请求到 X-AUTH-TOKEN。

Python

import requests

headers = {
 "X-AUTH-TOKEN": <API-KEY>
}

response = requests.get("https://apianalytics-server.com/api/data", headers=headers)
print(response.json())

Node.js

fetch("https://apianalytics-server.com/api/data", {
  headers: { "X-AUTH-TOKEN": <API-KEY> },
})
  .then((response) => {
    return response.json();
  })
  .then((data) => {
    console.log(data);
  });

cURL

curl --header "X-AUTH-TOKEN: <API-KEY>" https://apianalytics-server.com/api/data

参数

您可以通过在请求中提供 URL 参数来过滤您的数据。

• date - 指定请求发生的特定日期 (YYYY-MM-DD)
• dateFrom - 指定请求发生的日期范围的下限 (YYYY-MM-DD)
• dateTo - 指定请求发生的日期范围的上限（YYYY-MM-DD）
• ipAddress - 客户端的 IP 地址字符串
• status - 响应的整数状态码
• location - 客户端的两位位置代码

curl --header "X-AUTH-TOKEN: <API-KEY>" https://apianalytics-server.com/api/data?dateFrom=2022-01-01&dateTo=2022-06-01&status=200