Axum Analytics

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

入门指南

1. 生成 API 密钥

前往 https://apianalytics.dev/generate，点击一次即可生成您的唯一 API 密钥。此密钥用于监控您的 API 服务器，应私密存储。它还用于查看您的 API 分析仪表板和数据。

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

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

cargo add axum-analytics

use axum::{
    routing::get,
    Json, Router,
};
use serde::Serialize;
use std::net::SocketAddr;
use tokio;
use axum_analytics::Analytics;

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

async fn root() -> Json<JsonData> {
    let json_data = JsonData {
        message: "Hello World!".to_string(),
    };
    Json(json_data)
}

#[tokio::main]
async fn main() {
    let app = Router::new()
        .layer(Analytics::new(<API-KEY>))  // Add middleware
        .route("/", get(root));

    let addr = SocketAddr::from(([127, 0, 0, 1], 8080));
    axum::Server::bind(&addr)
        .serve(app.into_make_service())
        .await
        .unwrap();
}

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 中的头信息 X-AUTH-TOKEN 发送 GET 请求。

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