请求方法

  • GET:用于获取文档内容
  • POST:不可用于此路径

路径参数

  • /api/guidelines 默认返回中文指南
  • 支持语言扩展:/en/guidelines(英文)、/zh/guidelines(中文)

响应格式

  • 返回 JSON 数据结构
  • 示例响应:
    {
      "title": "API使用规范",
      "content": "请遵守以下规则..."
    }
    

使用示例

  1. 基础调用:GET /api/guidelines
  2. 带参数调用:GET /api/guidelines?lang=en

注意事项

  • 🚫 请勿在请求中包含敏感信息
  • 🔒 建议使用 HTTPS 协议
  • 📚 扩展阅读:API安全指南
api_guidelines
rest_api