跳转至

获取组织讨论详情

GET /api/v5/orgs/{org}/discuss/{number}

该接口用于根据组织路径与讨论编号获取指定组织的讨论详情,返回讨论标题、正文内容、作者信息、分类、评论数量、投票信息及标签列表等完整资料。

访问令牌支持说明

  • AtomGit 用户访问令牌(AtomGit user access tokens)

是否允许匿名访问

此接口允许匿名访问

请求参数

参数名 位置 类型 必填 说明
org path string 是 组织路径(path)
number path integer 是 讨论编号

响应参数

字段 类型 必返 可为空 说明
id string 是 否 讨论 ID
number integer 是 否 讨论编号
title string 是 否 讨论标题
md_content string 是 否 讨论内容(Markdown 格式)
created_at string 是 否 创建时间
updated_at string 是 否 更新时间
author object 是 否 讨论作者
is_lock integer 是 否 是否锁定
is_pin integer 是 否 是否置顶
is_category_pin integer 是 否 是否类型下置顶
is_closed integer 是 否 是否关闭
is_answered integer 是 否 是否采纳答案
comment_total integer 是 否 评论总数
category object 是 否 讨论分类
vote object 是 否 投票信息(仅投票类讨论返回)
vote_options object[] 是 否 投票选项信息(仅投票类讨论返回)
labels object[] 否 是 标签列表

author 对象

字段 类型 必返 可为空 说明
author.avatar_url string 是 否 头像地址
author.id string 是 否 用户 ID
author.object_id string 是 否 用户对象 ID
author.login string 是 否 登录名
author.name string 是 否 用户名

category 对象

字段 类型 必返 可为空 说明
category.id string 是 否 分类 ID
category.name string 是 否 分类名称
category.icon string 是 否 分类图标
category.description string 是 否 分类描述
category.type integer 是 否 分类类型

vote 对象

字段 类型 必返 可为空 说明
vote.id string 是 否 投票 ID
vote.created_at string 是 否 创建时间
vote.updated_at string 是 否 更新时间
vote.question string 是 否 投票内容
vote.vote_total integer 是 否 投票总数
vote.real_name boolean 是 否 是否实名
vote.creator_view_real_name boolean 是 否 创建者是否可以查看实名投票(0 否,1 是)
vote.modify_vote_times integer 是 否 可修改的投票次数
vote.designated_voter boolean 是 否 是否指定投票人(0 否,1 是)
vote.current_user_is_designated_voter boolean 是 否 当前用户是否是指定投票人
vote.designated_voter_size integer 是 否 指定投票人数量
vote.no_vote_user_size integer 是 否 未投票人数量

vote_options 数组元素

字段 类型 必返 可为空 说明
vote_options.id string 是 否 选项 ID
vote_options.created_at string 是 否 创建时间
vote_options.updated_at string 是 否 更新时间
vote_options.vote_option string 是 否 投票选项
vote_options.option_order integer 是 否 投票选项排序
vote_options.vote_total integer 是 否 此选项投票数
vote_options.vote_total_percent integer 是 否 此选项投票数百分比
vote_options.vote_id string 是 否 所属投票 ID
vote_options.vote_users object[] 否 是 投票用户列表

vote_options.vote_users 数组元素

字段 类型 必返 可为空 说明
vote_users.avatar_url string 否 是 头像地址
vote_users.id string 否 是 用户 ID
vote_users.object_id string 否 是 用户对象 ID
vote_users.login string 否 是 登录名
vote_users.name string 否 是 用户名

labels 数组元素

字段 类型 必返 可为空 说明
labels.id string 是 否 标签 ID
labels.name string 是 否 标签名称
labels.color string 是 否 标签颜色
labels.created_at string 是 否 创建时间
labels.updated_at string 是 否 更新时间

失败响应

该接口在参数缺失或资源不存在时会返回如下错误响应。

404 资源不存在

{
  "error": "not_found",
  "message": "讨论不存在"
}

HTTP 响应状态码

状态码 说明
200 成功(OK)
404 资源不存在(Not found)
500 服务器内部错误(Internal server error)

请求示例

参数说明

<org> 替换为组织路径(企业、组织或个人的地址 path);<number> 替换为讨论编号。

该接口允许匿名访问,调用时无需携带访问令牌;如需鉴权,也可在请求中携带访问令牌。

cURL

curl -X GET 'https://api.atomgit.com/api/v5/orgs/<org>/discuss/<number>' \
  -H 'Accept: application/json'

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/orgs/<org>/discuss/<number>", {
  headers: {
    "Accept": "application/json",
  },
});

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/orgs/<org>/discuss/<number>",
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

{
  "id": "discussion-001",
  "number": 12,
  "title": "如何部署 AtomGit 上的项目?",
  "md_content": "### 问题描述\n部署时遇到错误,请协助排查。",
  "created_at": "2026-10-01T10:00:00Z",
  "updated_at": "2026-10-02T11:30:00Z",
  "author": {
    "avatar_url": "https://api.atomgit.com/avatar.png",
    "id": "user-001",
    "object_id": "object-001",
    "login": "octocat",
    "name": "Octocat"
  },
  "is_lock": 0,
  "is_pin": 0,
  "is_category_pin": 0,
  "is_closed": 0,
  "is_answered": 0,
  "comment_total": 5,
  "category": {
    "id": "category-001",
    "name": "使用问题",
    "icon": "https://api.atomgit.com/category/icon.png",
    "description": "使用相关问题",
    "type": 1
  },
  "vote": {
    "id": "vote-001",
    "created_at": "2026-10-01T10:00:00Z",
    "updated_at": "2026-10-02T11:30:00Z",
    "question": "你支持这个方案吗?",
    "vote_total": 10,
    "real_name": true,
    "creator_view_real_name": false,
    "modify_vote_times": 2,
    "designated_voter": false,
    "current_user_is_designated_voter": false,
    "designated_voter_size": 0,
    "no_vote_user_size": 3
  },
  "vote_options": [
    {
      "id": "vote-option-001",
      "created_at": "2026-10-01T10:00:00Z",
      "updated_at": "2026-10-02T11:30:00Z",
      "vote_option": "支持",
      "option_order": 1,
      "vote_total": 7,
      "vote_total_percent": 70,
      "vote_id": "vote-001",
      "vote_users": [
        {
          "avatar_url": "https://api.atomgit.com/avatar.png",
          "id": "user-001",
          "object_id": "object-001",
          "login": "octocat",
          "name": "Octocat"
        }
      ]
    }
  ],
  "labels": [
    {
      "id": "label-001",
      "name": "bug",
      "color": "#d73a4a",
      "created_at": "2026-10-01T10:00:00Z",
      "updated_at": "2026-10-02T11:30:00Z"
    }
  ]
}

错误码

错误码 说明
400 参数错误或请求无法解析
401 未认证或凭证无效(缺少/无效的访问凭证)
404 请求路径不存在或资源不存在
405 请求方法不支持
429 请求过于频繁,触发限流
500 系统内部错误

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc