Skillppx logo

Slingdata.io API Spec

用于构建 Sling 数据提取的 REST API 规范，支持多种认证与分页方式。

已扫描
适合谁
需要对接外部 API 的开发者、从事数据集成与 ETL 流程的工程师
不适合谁
无编程基础的普通用户、仅需简单数据下载的非技术用户
国内可用性
需网络配置。可能需要网络配置或第三方服务可访问。
安装难度
新手友好（★☆☆）。基于终端操作、依赖、API Key 和本地环境要求的初步判断。

安装与下载

openclaw skills install @flarco/sling-api-specs
下载官方 ZIP

Skill 说明

命令、参数、文件名以原文为准

API 规范

API 规范是用于从 REST API 提取数据的 YAML 定义。它们可自动处理身份验证、分页、响应处理和增量同步。

何时使用

  • 从 REST API（仅 GET 端点）提取数据
  • 构建增量同步工作流
  • 处理复杂的分页模式
  • 处理嵌套的 JSON 响应
  • 使用队列串联多个 API 调用

基本结构

name: "我的 API"
description: "从我的 API 提取数据"

authentication:
  type: "static"
  headers:
    Authorization: "Bearer {secrets.api_token}"

defaults:
  state:
    base_url: "https://api.example.com/v1"
  request:
    headers:
      Accept: "application/json"

endpoints:
  users:
    description: "获取用户列表"
    request:
      url: "{state.base_url}/users"
    response:
      records:
        jmespath: "data[]"
        primary_key: ["id"]

MCP 操作

解析规范文件

{
  "action": "parse",
  "input": {"file_path": "/path/to/spec.yaml"}
}

测试端点

{
  "action": "test",
  "input": {
    "connection": "MY_API",
    "endpoints": ["users"],
    "debug": true,
    "limit": 10
  }
}

主题参考

此技能包含构建 API 规范各方面的详细文档：

主题描述
[AUTHENTICATION.md](AUTHENTICATION.md)所有 8 种身份验证类型（静态、基本、OAuth2、AWS、HMAC、序列）
[ENDPOINTS.md](ENDPOINTS.md)端点配置、设置/清理序列
[REQUEST.md](REQUEST.md)HTTP 请求配置、速率限制
[PAGINATION.md](PAGINATION.md)所有分页模式（游标、偏移、页码、链接头）
[RESPONSE.md](RESPONSE.md)记录提取、去重
[PROCESSORS.md](PROCESSORS.md)数据转换、聚合
[VARIABLES.md](VARIABLES.md)变量作用域、表达式、渲染顺序
[QUEUES.md](QUEUES.md)端点串联、迭代
[INCREMENTAL.md](INCREMENTAL.md)同步状态、上下文变量
[DYNAMIC.md](DYNAMIC.md)运行时动态生成端点
[FUNCTIONS.md](FUNCTIONS.md)表达式函数参考
[RULES.md](RULES.md)响应规则、重试机制、错误处理

快速参考

身份验证类型

类型使用场景
staticAPI 密钥、Bearer Token
basic用户名/密码
oauth2OAuth 2.0 流程（client_credentials、authorization_code、device_code）
aws-sigv4AWS 服务
hmac加密交易所、自定义签名
sequence多步骤自定义认证

分页模式

模式示例
游标starting_after、page_token
偏移offset + limit
页码page 数字
链接头GitHub 风格的 rel="next"

变量作用域

作用域描述
secrets.*来自连接的凭据
state.*端点状态变量
sync.*上次运行中持久化的数据
response.*HTTP 响应数据
record.*当前处理器中的记录
queue.*端点串联相关

完整文档

参见 https://docs.slingdata.io/concepts/api-specs.md 获取完整参考。

F
@flarco

已收录 1 个 Skill

相关推荐