创建组织讨论¶
POST /api/v5/orgs/{org}/discuss
该接口用于在指定组织下创建新的讨论,调用时需提供讨论标题、讨论内容(markdown 格式)及所属分类名称,创建成功后返回讨论的完整信息。
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口不允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
org |
path | string | 是 | 组织路径(path) |
access_token |
query | string | 是 | 用户授权码 |
Request Body:
请求体为 JSON 格式,必填字段为 title、md_content 与 category_name。
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"title": {
"description": "讨论标题",
"type": "string"
},
"md_content": {
"description": "讨论内容(markdown 格式)",
"type": "string"
},
"category_name": {
"description": "讨论所属分类名称",
"type": "string"
}
},
"required": ["title", "md_content", "category_name"]
}
响应参数¶
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
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 | 是 | 否 | 分类信息 |
author 对象
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
author.avatar_url |
string | 是 | 否 | 头像 URL |
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 | 是 | 否 | 分类类型 |
失败响应¶
该接口需要认证,未携带有效访问令牌或令牌无效时返回 401;请求体参数缺失或格式错误时返回 400。错误响应字段名以后端实际返回为准。
401 未认证
400 参数错误
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
400 |
参数错误或请求无法解析 |
401 |
需要认证(Requires authentication) |
403 |
禁止访问(Forbidden) |
404 |
请求路径不存在 |
405 |
请求方法不支持 |
429 |
请求过于频繁,触发限流 |
500 |
系统内部错误 |
请求示例¶
参数说明¶
<org>替换为组织路径(path);<token>替换为你的 AtomGit 用户访问令牌。
cURL¶
curl -X POST 'https://api.atomgit.com/api/v5/orgs/<org>/discuss?access_token=<token>' -H 'Content-Type: application/json' -d '{"title":"讨论标题","md_content":"讨论内容","category_name":"分类名称"}'
JavaScript¶
// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/orgs/<org>/discuss?access_token=<token>", {
method: "POST",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify({
title: "讨论标题",
md_content: "讨论内容",
category_name: "分类名称",
}),
});
if (!response.ok) {
throw new Error(`请求失败: ${response.status}`);
}
const data = await response.json();
console.log(data);
Python¶
import requests
resp = requests.post(
"https://api.atomgit.com/api/v5/orgs/<org>/discuss",
params={"access_token": "<token>"},
json={"title": "讨论标题", "md_content": "讨论内容", "category_name": "分类名称"},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
响应示例¶
状态码: 200
{
"id": "o_xxxx",
"number": 3,
"title": "如何快速上手",
"md_content": "这是一段讨论内容",
"created_at": "2026-10-14T00:00:00Z",
"updated_at": "2026-10-14T00:00:00Z",
"author": {
"avatar_url": "https://api.atomgit.com/avatar.png",
"id": "u_xxxx",
"object_id": "obj_xxxx",
"login": "octocat",
"name": "octocat"
},
"is_lock": 0,
"is_pin": 0,
"is_category_pin": 0,
"is_closed": 0,
"is_answered": 0,
"comment_total": 0,
"category": {
"id": "c_xxxx",
"name": "默认分类",
"icon": "https://api.atomgit.com/icon.png",
"description": "默认讨论分类",
"type": 0
}
}
错误码¶
| 错误码 | 说明 |
|---|---|
401 |
未认证或凭证无效(缺少/无效的访问凭证) |
400 |
参数错误或请求无法解析 |
404 |
请求路径不存在 |
405 |
请求方法不支持 |
429 |
请求过于频繁,触发限流 |
500 |
系统内部错误 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc