claude-howto/zh/07-plugins/documentation/templates/api-endpoint.md

[方法] /api/v1/[endpoint]

描述

简要说明这个端点的作用。

身份验证

所需的身份验证方式，例如 Bearer token。

参数

路径参数

名称	类型	必填	描述
id	string	是	资源 ID

查询参数

名称	类型	必填	描述
page	integer	否	页码（默认：1）
limit	integer	否	每页条数（默认：20）

请求体

{
  "field": "value"
}

响应

200 OK

{
  "success": true,
  "data": {
    "id": "123",
    "name": "示例"
  }
}

400 Bad Request

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "无效输入"
  }
}

404 Not Found

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "资源未找到"
  }
}

示例

cURL

curl -X GET "https://api.example.com/api/v1/endpoint" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch('/api/v1/endpoint', {
  headers: {
    'Authorization': 'Bearer token',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

Python

import requests

response = requests.get(
    'https://api.example.com/api/v1/endpoint',
    headers={'Authorization': 'Bearer token'}
)
data = response.json()

限流

• 已认证用户每小时 1000 次请求
• 公开端点每小时 100 次请求

相关端点

• GET /api/v1/related
• POST /api/v1/related