超腾开源平台内容模块

内容模块 API

概述

内容模块提供博客、微博、Wiki、产品文档等内容管理功能，支持内容创建、编辑、发布、评论、AI 辅助等功能。

目录

• 博客管理
• 微博管理
• Wiki 文档管理
• 产品文档管理
• 主题管理
• 域名白名单
• 意见反馈
• 留言板
• 友情链接
• 邮件订阅

博客管理

博客模块提供文章的创建、编辑、发布、评论等功能。

博客主表 CRUD

获取博客详情

接口地址: GET /api/content/blogs/detail

需要认证: 是

请求参数:

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "操作成功",
  "data": {
    "id": "1",
    "title": "我的第一篇博客",
    "abstract": "这是博客摘要",
    "keywords": "博客,技术",
    "content": "博客内容...",
    "author_id": "1",
    "author_name": "张三",
    "app_id": "1",
    "app_name": "超腾论文",
    "blog_type": "blog",
    "image_urls": ["https://example.com/image1.jpg"],
    "status": "published",
    "like_count": 10,
    "is_top": false,
    "view_count": 100,
    "create_time": "2026-01-01T00:00:00Z",
    "update_time": "2026-01-01T00:00:00Z",
    "published_time": "2026-01-01T00:00:00Z"
  }
}

获取博客列表

接口地址: GET /api/content/blogs/list

需要认证: 是

请求参数:

获取博客分页

接口地址: GET /api/content/blogs/page

需要认证: 是

请求参数:

创建博客

接口地址: POST /api/content/blogs/create

需要认证: 是

请求体:

{
  "title": "我的第一篇博客",
  "abstract": "这是博客摘要",
  "keywords": "博客,技术",
  "content": "博客内容...",
  "blog_type": "blog"
}

请求字段说明:

更新博客

接口地址: POST /api/content/blogs/update

需要认证: 是

请求体: 同创建博客，需包含 id 字段。

删除博客

接口地址: POST /api/content/blogs/delete

需要认证: 是

请求参数:

发布博客

接口地址: POST /api/content/blogs/publish

需要认证: 是

请求参数:

博客图片管理

上传博客图片

接口地址: POST /api/content/blogs/{blog_id}/images

需要认证: 是

路径参数:

请求参数: multipart/form-data

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "上传成功",
  "data": [
    {
      "id": "1",
      "blog_id": "1",
      "image_url": "https://example.com/image1.jpg",
      "image_type": "content",
      "sort": 0,
      "create_time": "2026-01-01T00:00:00Z"
    }
  ]
}

获取博客图片列表

接口地址: GET /api/content/blogs/{blog_id}/images

需要认证: 是

删除博客图片

接口地址: POST /api/content/blogs/images/{image_id}

需要认证: 是

获取博客图片详情

接口地址: GET /api/content/blogs/image/detail

需要认证: 是

更新博客图片

接口地址: POST /api/content/blogs/image/update

需要认证: 是

博客评论管理

获取博客评论详情

接口地址: GET /api/content/blogs/comment/detail

需要认证: 是

获取博客评论列表

接口地址: GET /api/content/blogs/comment/list

需要认证: 是

请求参数:

获取博客评论分页

接口地址: GET /api/content/blogs/comment/page

需要认证: 是

创建博客评论

接口地址: POST /api/content/blogs/comment/create

需要认证: 是

请求体:

{
  "blog_id": "1",
  "content": "这是评论内容",
  "parent_id": "0"
}

字段说明:

更新博客评论

接口地址: POST /api/content/blogs/comment/update

需要认证: 是

删除博客评论

接口地址: POST /api/content/blogs/comment/delete

需要认证: 是

博客 AI 功能

AI 提取博客摘要

接口地址: POST /api/content/blogs/ai-extract-abstract

需要认证: 是

请求体:

{
  "content": "这是博客的完整内容..."
}

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "提取成功",
  "data": "这是AI提取的摘要..."
}

AI 生成博客标题

接口地址: POST /api/content/blogs/ai-generate-title

需要认证: 是

请求体:

{
  "content": "这是博客的完整内容..."
}

AI 提取博客关键词

接口地址: POST /api/content/blogs/ai-extract-keywords

需要认证: 是

请求体:

{
  "content": "这是博客的完整内容..."
}

自动生成评论

接口地址: POST /api/content/blogs/auto-generate-comment

需要认证: 是

请求参数:

微博管理

微博模块提供短内容的创建、编辑、评论等功能。

微博主表 CRUD

所有接口与博客模块类似，但模型为 MicroblogVO，没有摘要和关键词字段，只包含内容字段。

MicroblogVO Schema:

{
  "id": "string | null",
  "content": "string | null",
  "author_id": "string | null",
  "author_name": "string | null",
  "app_id": "string | null",
  "app_name": "string | null",
  "image_urls": ["string"] | null,
  "status": "draft | published | deleted",
  "like_count": "int | default 0",
  "is_top": "boolean | default false",
  "view_count": "int | default 0",
  "create_time": "datetime | null",
  "update_time": "datetime | null",
  "published_time": "datetime | null"
}

微博图片管理

微博评论管理

Wiki 文档管理

Wiki 文档模块提供与 XWiki 集成的文档管理功能，支持空间管理、文档管理、SEO 优化等功能。

Wiki 空间管理

获取 XWiki 空间列表

接口地址: GET /api/content/xwiki/space/list

需要认证: 是

获取 XWiki 空间分页

接口地址: GET /api/content/xwiki/space/page

需要认证: 是

获取 XWiki 空间树

接口地址: GET /api/content/xwiki/space/tree

需要认证: 是

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "操作成功",
  "data": [
    {
      "id": "1",
      "name": "Main",
      "xwiki_id": "Main",
      "url": "https://wiki.example.com/xwiki/bin/view/Main/",
      "page_url": "https://wiki.example.com/xwiki/bin/view/Main/WebHome",
      "children": [
        {
          "id": "2",
          "name": "Documentation",
          "xwiki_id": "Main.Documentation",
          "children": []
        }
      ]
    }
  ]
}

Wiki 文档管理

获取 XWiki 文档详情

接口地址: POST /api/content/xwiki/doc/detail

需要认证: 是

请求体:

{
  "id": "1"
}

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "操作成功",
  "data": {
    "id": "1",
    "xwiki_id": "Main.WebHome",
    "title": "Welcome",
    "author": "admin",
    "url": "https://wiki.example.com/xwiki/bin/view/Main/WebHome",
    "create_time": "2026-01-01T00:00:00Z",
    "update_time": "2026-01-01T00:00:00Z",
    "content": "<p>Wiki content...</p>",
    "md5_digest": "abc123...",
    "modified": false,
    "optimized": false,
    "optimize_time": null,
    "pretty_title": "Welcome - Main",
    "pretty_h1": "Welcome",
    "pretty_description": "Welcome page",
    "pretty_keywords": "welcome,home",
    "pretty_abstract": "This is the welcome page",
    "pretty_content": "<p>Optimized content...</p>",
    "view_count": 100,
    "like_count": 10,
    "comment_count": 5,
    "redirect": false,
    "redirect_url": null,
    "content_need_optimized": false,
    "content_has_optimized": false,
    "topic_id": "1"
  }
}

获取 XWiki 文档列表

接口地址: GET /api/content/xwiki/doc/list

需要认证: 是

请求参数:

获取 XWiki 文档分页

接口地址: GET /api/content/xwiki/doc/page

需要认证: 是

SEO 优化 XWiki 文档

接口地址: POST /api/content/xwiki/doc/seo-optimize

需要认证: 是

请求体:

{
  "id": "1"
}

取消 SEO 优化 XWiki 文档

接口地址: POST /api/content/xwiki/doc/cancel-seo-optimize

需要认证: 是

人工优化完成

接口地址: POST /api/content/xwiki/doc/complete-optimize

需要认证: 是

设置 XWiki 文档重定向

接口地址: POST /api/content/xwiki/doc/set-redirect

需要认证: 是

请求体:

{
  "id": "1",
  "redirect_url": "https://example.com/new-url"
}

取消 XWiki 文档重定向

接口地址: POST /api/content/xwiki/doc/cancel-redirect

需要认证: 是

设置 XWiki 文档为专题

接口地址: POST /api/content/xwiki/doc/set-topic

需要认证: 是

请求体:

{
  "id": "1",
  "topic_id": "1"
}

取消 XWiki 文档专题

接口地址: POST /api/content/xwiki/doc/cancel-topic

需要认证: 是

删除 Wiki

接口地址: POST /api/content/xwiki/doc/delete

需要认证: 是

Wiki 评论管理

自动生成文档评论

接口地址: POST /api/content/xwiki/doc/auto-generate-comment

需要认证: 是

产品文档管理

产品文档模块提供产品文档的管理功能，类似博客模块。

产品文档主表 CRUD

ProductVO Schema:

{
  "id": "string | null",
  "title": "string | null",
  "abstract": "string | null",
  "keywords": "string | null",
  "content": "string | null",
  "author_id": "string | null",
  "author_name": "string | null",
  "app_id": "string | null",
  "app_name": "string | null",
  "image_urls": ["string"] | null",
  "status": "draft | published | deleted",
  "like_count": "int | default 0",
  "is_top": "boolean | default false",
  "view_count": "int | default 0",
  "parent_id": "string | null",
  "code": "string | null",
  "create_time": "datetime | null",
  "update_time": "datetime | null",
  "published_time": "datetime | null"
}

产品文档图片管理

产品文档评论管理

产品文档 AI 功能

自动生成产品文档评论

接口地址: POST /api/content/products/auto-generate-comment

需要认证: 是

主题管理

主题模块用于管理 Wiki 文档的专题分类。

主题 CRUD

TopicVO Schema:

{
  "id": "string | null",
  "name": "string",
  "description": "string | null",
  "cover_url": "string | null",
  "status": "active | inactive",
  "create_user": "string | null",
  "update_user": "string | null",
  "create_time": "string | null",
  "update_time": "string | null"
}

域名白名单

域名白名单模块用于管理允许外链的域名列表。

域名白名单 CRUD

从 XWiki 同步域名

接口地址: POST /api/content/domain-whitelists/sync-from-xwiki

需要认证: 是

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "同步成功",
  "data": ["example.com", "another.com"]
}

意见反馈

意见反馈模块用于接收和管理用户反馈。

反馈 CRUD

FeedbackVO Schema:

{
  "id": "string | null",
  "app_id": "string | null",
  "app_name": "string | null",
  "user_id": "string | null",
  "user_name": "string | null",
  "title": "string | null",
  "content": "string | null",
  "contact_info": "string | null",
  "status": "pending | processing | resolved | rejected",
  "admin_reply": "string | null",
  "replied_by": "string | null",
  "replied_by_name": "string | null",
  "create_time": "datetime | null",
  "update_time": "datetime | null"
}

留言板

留言板模块提供公开留言功能。

留言 CRUD

GuestbookVO Schema:

{
  "id": "string | null",
  "parent_id": "string | null",
  "reply_to_id": "string | null",
  "user_id": "string | null",
  "user_name": "string | null",
  "content": "string | null",
  "contact_info": "string | null",
  "is_public": "boolean | null",
  "is_pinned": "boolean | null",
  "ip_address": "string | null",
  "create_time": "datetime | null",
  "update_time": "datetime | null",
  "reply_to_user_name": "string | null",
  "children": ["GuestbookVO"] | null
}

友情链接

友情链接模块用于管理网站的友情链接。

友情链接 CRUD

LinkVO Schema:

{
  "id": "string | null",
  "name": "string | null",
  "url": "string | null",
  "link_url": "string | null",
  "logo_url": "string | null",
  "description": "string | null",
  "email": "string | null",
  "status": "pending | approved | rejected",
  "sort_order": "int | default 0",
  "admin_reply": "string | null",
  "create_time": "datetime | null",
  "update_time": "datetime | null"
}

LinkCheckResult Schema:

{
  "id": "string",
  "name": "string",
  "url": "string",
  "robots_valid": "boolean",
  "backlink_valid": "boolean",
  "error_message": "string | null"
}

邮件订阅

邮件订阅模块用于管理用户的邮件订阅。

邮件订阅 CRUD

EmailSubscriptionVO Schema:

{
  "id": "string | null",
  "email": "string | null",
  "subscription_type": "blog | product | xwiki | all",
  "status": "active | inactive",
  "verification_code": "string | null",
  "is_verified": "boolean | default false",
  "create_time": "datetime | null",
  "update_time": "datetime | null"
}

枚举类型说明

博客类型 (BlogType)

内容状态 (ContentStatus)

评论状态 (CommentStatus)

反馈状态 (FeedbackStatus)

链接状态 (LinkStatus)

主题状态 (TopicStatus)

订阅类型 (EmailSubscriptionType)

订阅状态 (EmailSubscriptionStatus)

使用示例

Python 示例

import requests

base_url = 'http://localhost:8000/api/content'
token = 'your_access_token'
headers = {'Authorization': f'Bearer {token}'}

# 创建博客
response = requests.post(
    f'{base_url}/blogs/create',
    headers=headers,
    json={
        'title': '我的第一篇博客',
        'content': '这是博客内容...',
        'blog_type': 'blog'
    }
)
print(response.json())

# 上传博客图片
files = {'files': open('image.jpg', 'rb')}
response = requests.post(
    f'{base_url}/blogs/1/images',
    headers=headers,
    files=files
)
print(response.json())

# 创建博客评论
response = requests.post(
    f'{base_url}/blogs/comment/create',
    headers=headers,
    json={
        'blog_id': '1',
        'content': '这是评论内容'
    }
)
print(response.json())

# AI 提取摘要
response = requests.post(
    f'{base_url}/blogs/ai-extract-abstract',
    headers=headers,
    json={
        'content': '这是博客的完整内容...'
    }
)
print(response.json())

JavaScript 示例

// 创建博客
async function createBlog(token, blogData) {
  const response = await fetch(
    "http://localhost:8000/api/content/blogs/create",
    {
      method: "POST",
      headers: {
        Authorization: `Bearer ${token}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify(blogData),
    }
  );
  return await response.json();
}

// 上传图片
async function uploadBlogImages(token, blogId, files) {
  const formData = new FormData();
  files.forEach((file) => formData.append("files", file));

  const response = await fetch(
    `http://localhost:8000/api/content/blogs/${blogId}/images`,
    {
      method: "POST",
      headers: { Authorization: `Bearer ${token}` },
      body: formData,
    }
  );
  return await response.json();
}

// 获取博客列表
async function getBlogs(token, filters = {}) {
  const params = new URLSearchParams(filters);
  const response = await fetch(
    `http://localhost:8000/api/content/blogs/list?${params}`,
    {
      headers: { Authorization: `Bearer ${token}` },
    }
  );
  return await response.json();
}

注意事项

1. 图片上传: 上传图片使用 multipart/form-data 格式，支持同时上传多张图片。
2. AI 功能: AI 功能需要配置相应的大模型服务，确保服务可用性。
3. 评论审核: 评论默认为待审核状态，管理员审核通过后才会公开显示。
4. Wiki 同步: Wiki 文档数据从 XWiki 同步，需要确保 XWiki 服务配置正确。
5. SEO 优化: Wiki 文档的 SEO 优化功能包括提取标题、关键词、摘要、描述等。
6. 外链白名单: Wiki 内容中的外链接域名需要在白名单中才能显示。
7. 匿名访问: 部分接口支持匿名访问（如创建反馈、匿名留言），但功能受限。
8. 分页查询: 大量数据建议使用分页查询，默认每页 10 条记录。

相关文档

• 数据模型参考
• 系统模块 API
• AI 模块 API
• API 概览