欢迎使用 community-forum 的 API 文档!以下是关于 API 的核心信息与使用说明:


📌 1. API 文档概览

本文档提供以下功能:

  • 接口列表与参数说明
  • 请求示例与响应格式
  • 安全认证方式
  • 开发者工具推荐

🔗 点击此处查看快速入门指南


📝 2. 核心接口说明

📌 2.1 获取主题列表

路径/topics
方法:GET
参数

  • page_size(可选):每页返回的条目数,默认 20
  • page_num(可选):分页编号,默认 1
    响应示例
{
  "data": [
    {"id": 1, "name": "技术讨论", "description": "关于编程与开发的交流"},
    {"id": 2, "name": "生活分享", "description": "日常生活的点滴记录"}
  ]
}

📌 2.2 创建新主题

路径/topics
方法:POST
请求体

{
  "name": "新主题名称",
  "description": "主题描述内容"
}

🛠 3. 开发者工具

推荐使用以下工具进行 API 测试与调试:

  • Swagger UI(内置文档交互界面)
  • Postman(支持自定义请求头与参数)
  • cURL(命令行工具,适合自动化脚本)

📷

swagger_ui


⚠ 4. 注意事项

  • 所有请求需携带 Authorization 头(Bearer Token)
  • 避免在请求中包含敏感信息(如用户密码)
  • 文档更新频率:每周三同步最新接口定义

📚 5. 扩展阅读

📷

api_documentation