wx/hl-api-changelog
1
0
派生 0
代码 工单 合并请求 Actions 软件包 项目 版本发布 百科 动态
hl-api-changelog/hl-guide-service.md
API Changelog Bot 94fa5db42c docs: sync 13 services (0 breaking changes)
2026-03-17 09:27:35 +08:00

25 KiB
原始文件 Blame 文件历史

攻略服务 API 文档

服务: hl-guide-service 接口总数: 21

目录

  • 攻略分类管理 (7 个接口)
  • 攻略文章管理 (8 个接口)
  • 攻略标签管理 (6 个接口)

攻略分类管理

POST /admin/guide/category

创建分类

创建攻略分类，分类名称不可重复。创建后默认启用，排序值越小越靠前。

权限：需管理员登录。

请求体 CategoryCreateRequest

字段 类型 必填 说明
categoryName string 是 分类名称
coverMaterialId long 封面素材ID
coverUrl string 封面URL
description string 描述
icon string 图标
sortOrder int 排序（默认0）

响应 统一响应结果«攻略分类»

字段 类型 必填 说明
code int 状态码
data 攻略分类 响应数据
  articleCount int 文章数量
  categoryId long 分类ID
  categoryName string 分类名称
  coverMaterialId long 封面素材ID
  coverUrl string 封面URL
  createdAt string 创建时间
  description string 描述
  icon string 图标
  sortOrder int 排序
  status int 状态：0=禁用，1=启用
message string 响应消息

GET /admin/guide/category/enabled

启用的分类列表

仅返回状态为启用的分类，创建文章时用于选择分类

响应 统一响应结果«List«攻略分类»»

字段 类型 必填 说明
code int 状态码
data 攻略分类[] 响应数据
  articleCount int 文章数量
  categoryId long 分类ID
  categoryName string 分类名称
  coverMaterialId long 封面素材ID
  coverUrl string 封面URL
  createdAt string 创建时间
  description string 描述
  icon string 图标
  sortOrder int 排序
  status int 状态：0=禁用，1=启用
message string 响应消息

GET /admin/guide/category/list

分类列表

返回全部攻略分类（含启用和停用），按排序值升序排列

关联字典：

  • common_status：通用状态（列表显示，ACTIVE=启用/INACTIVE=停用）

响应 统一响应结果«List«攻略分类»»

字段 类型 必填 说明
code int 状态码
data 攻略分类[] 响应数据
  articleCount int 文章数量
  categoryId long 分类ID
  categoryName string 分类名称
  coverMaterialId long 封面素材ID
  coverUrl string 封面URL
  createdAt string 创建时间
  description string 描述
  icon string 图标
  sortOrder int 排序
  status int 状态：0=禁用，1=启用
message string 响应消息

PUT /admin/guide/category/{categoryId}

更新分类

更新攻略分类的名称、图标、描述等信息。

权限：需管理员登录。

路径参数

参数 类型 必填 说明
categoryId integer 是 categoryId

请求体 CategoryUpdateRequest

字段 类型 必填 说明
categoryName string 分类名称
coverMaterialId long 封面素材ID
coverUrl string 封面URL
description string 描述
icon string 图标
sortOrder int 排序

响应 统一响应结果«攻略分类»

字段 类型 必填 说明
code int 状态码
data 攻略分类 响应数据
  articleCount int 文章数量
  categoryId long 分类ID
  categoryName string 分类名称
  coverMaterialId long 封面素材ID
  coverUrl string 封面URL
  createdAt string 创建时间
  description string 描述
  icon string 图标
  sortOrder int 排序
  status int 状态：0=禁用，1=启用
message string 响应消息

DELETE /admin/guide/category/{categoryId}

删除分类

删除分类前需确保分类下无文章，否则删除失败

路径参数

参数 类型 必填 说明
categoryId integer 是 categoryId

响应 统一响应结果«Void»

PUT /admin/guide/category/{categoryId}/sort

更新分类排序

更新分类的排序值，排序值越小越靠前。影响小程序端分类导航的展示顺序。

权限：需管理员登录。

路径参数

参数 类型 必填 说明
categoryId integer 是 categoryId

请求体 CategorySortRequest

字段 类型 必填 说明
sortOrder int 是 排序值

响应 统一响应结果«Void»

PUT /admin/guide/category/{categoryId}/status

更新分类状态

启用或停用分类。停用后该分类下的文章不会在小程序端展示，但不影响已有文章

关联字典：

  • common_status：通用状态（状态切换，ACTIVE=启用/INACTIVE=停用）

路径参数

参数 类型 必填 说明
categoryId integer 是 categoryId

请求体 StatusRequest

字段 类型 必填 说明
status int 是 状态值

响应 统一响应结果«Void»

攻略文章管理

POST /admin/guide/article

创建文章

创建攻略文章，需指定分类。创建后默认为草稿状态，需手动发布后小程序端才可见。

权限：需管理员登录。

关联字典：

  • wiki_status：文章状态（创建后默认DRAFT）

请求体 ArticleCreateRequest

字段 类型 必填 说明
authorName string 作者名称
bannerMaterialIds long[] 轮播图素材ID列表
categoryId long 是 分类ID
content string 正文内容
coverMaterialId long 封面素材ID
coverUrl string 封面URL
resources ArticleResourceItem[] 关联资源列表
  resourceId long 是 资源ID
  resourceName string 是 资源名称
  resourceType string 是 资源类型：SCENIC/RESTAURANT/HOTEL/ACTIVITY/PRODUCT
  sortOrder int 排序
sortOrder int 排序（默认0）
source string 来源
subtitle string 副标题
summary string 摘要
tagIds long[] 标签ID列表
title string 是 标题

响应 统一响应结果«攻略文章详情»

字段 类型 必填 说明
code int 状态码
data 攻略文章详情 响应数据
  articleId long 文章ID
  authorName string 作者名称
  bannerMaterialIds long[] 轮播图素材ID列表
  categoryId long 分类ID
  categoryName string 分类名称
  content string 正文内容
  coverMaterialId long 封面素材ID
  coverUrl string 封面URL
  createdAt string 创建时间
  favoriteCount int 收藏数
  isRecommend int 是否推荐：0=否，1=是
  isTop int 是否置顶：0=否，1=是
  likeCount int 点赞数
  publishTime string 发布时间
  resources 文章关联资源[] 关联资源列表
    resourceId long 资源ID
    resourceName string 资源名称
    resourceType string 资源类型：SCENIC/RESTAURANT/HOTEL/ACTIVITY/PRODUCT
    sortOrder int 排序
  sortOrder int 排序
  source string 来源
  status int 状态：0=草稿，1=已发布，2=已下架
  subtitle string 副标题
  summary string 摘要
  tags 攻略标签[] 标签列表
    createdAt string 创建时间
    tagColor string 标签颜色
    tagId long 标签ID
    tagName string 标签名称
    tagType int 标签类型：0=系统管理，1=自定义
    useCount int 使用次数
  title string 标题
  updatedAt string 更新时间
  viewCount int 浏览量
message string 响应消息

GET /admin/guide/article/list

文章列表

分页查询攻略文章，支持按分类、状态、关键词筛选

关联字典：

  • wiki_status：文章状态（列表筛选+显示）

查询参数

参数 类型 必填 说明 示例
categoryId integer(int64) 分类ID
isRecommend integer(int32) 是否推荐：0=否，1=是
isTop integer(int32) 是否置顶：0=否，1=是
keyword string 关键词（搜索标题/摘要）
orderBy string 排序字段：sortOrder/publishTime/viewCount/createdAt（默认createdAt）
orderDir string 排序方向：asc/desc（默认desc）
page integer(int32) 页码（默认1）
pageSize integer(int32) 每页数量（默认20，最大100）
status integer(int32) 状态：0=草稿，1=已发布，2=已下架

响应 统一响应结果«分页结果«攻略文章列表项»»

字段 类型 必填 说明
code int 状态码
data 分页结果«攻略文章列表项» 响应数据
  page int 当前页码
  pageSize int 每页条数
  records 攻略文章列表项[] 数据列表
    articleId long 文章ID
    categoryId long 分类ID
    categoryName string 分类名称
    coverUrl string 封面URL
    createdAt string 创建时间
    isRecommend int 是否推荐：0=否，1=是
    isTop int 是否置顶：0=否，1=是
    publishTime string 发布时间
    sortOrder int 排序
    status int 状态：0=草稿，1=已发布，2=已下架
    summary string 摘要
    tags 攻略标签[] 标签列表
    title string 标题
    viewCount int 浏览量
  total int 总记录数
message string 响应消息

GET /admin/guide/article/{articleId}

文章详情

关联字典：

  • wiki_status：文章状态（显示）

路径参数

参数 类型 必填 说明
articleId integer 是 articleId

响应 统一响应结果«攻略文章详情»

字段 类型 必填 说明
code int 状态码
data 攻略文章详情 响应数据
  articleId long 文章ID
  authorName string 作者名称
  bannerMaterialIds long[] 轮播图素材ID列表
  categoryId long 分类ID
  categoryName string 分类名称
  content string 正文内容
  coverMaterialId long 封面素材ID
  coverUrl string 封面URL
  createdAt string 创建时间
  favoriteCount int 收藏数
  isRecommend int 是否推荐：0=否，1=是
  isTop int 是否置顶：0=否，1=是
  likeCount int 点赞数
  publishTime string 发布时间
  resources 文章关联资源[] 关联资源列表
    resourceId long 资源ID
    resourceName string 资源名称
    resourceType string 资源类型：SCENIC/RESTAURANT/HOTEL/ACTIVITY/PRODUCT
    sortOrder int 排序
  sortOrder int 排序
  source string 来源
  status int 状态：0=草稿，1=已发布，2=已下架
  subtitle string 副标题
  summary string 摘要
  tags 攻略标签[] 标签列表
    createdAt string 创建时间
    tagColor string 标签颜色
    tagId long 标签ID
    tagName string 标签名称
    tagType int 标签类型：0=系统管理，1=自定义
    useCount int 使用次数
  title string 标题
  updatedAt string 更新时间
  viewCount int 浏览量
message string 响应消息

PUT /admin/guide/article/{articleId}

更新文章

更新攻略文章的标题、内容、封面图、分类等信息。已发布的文章更新后立即生效。

权限：需管理员登录。

路径参数

参数 类型 必填 说明
articleId integer 是 articleId

请求体 ArticleUpdateRequest

字段 类型 必填 说明
authorName string 作者名称
bannerMaterialIds long[] 轮播图素材ID列表
categoryId long 分类ID
content string 正文内容
coverMaterialId long 封面素材ID
coverUrl string 封面URL
resources ArticleResourceItem[] 关联资源列表
  resourceId long 是 资源ID
  resourceName string 是 资源名称
  resourceType string 是 资源类型：SCENIC/RESTAURANT/HOTEL/ACTIVITY/PRODUCT
  sortOrder int 排序
sortOrder int 排序
source string 来源
subtitle string 副标题
summary string 摘要
tagIds long[] 标签ID列表
title string 标题

响应 统一响应结果«攻略文章详情»

字段 类型 必填 说明
code int 状态码
data 攻略文章详情 响应数据
  articleId long 文章ID
  authorName string 作者名称
  bannerMaterialIds long[] 轮播图素材ID列表
  categoryId long 分类ID
  categoryName string 分类名称
  content string 正文内容
  coverMaterialId long 封面素材ID
  coverUrl string 封面URL
  createdAt string 创建时间
  favoriteCount int 收藏数
  isRecommend int 是否推荐：0=否，1=是
  isTop int 是否置顶：0=否，1=是
  likeCount int 点赞数
  publishTime string 发布时间
  resources 文章关联资源[] 关联资源列表
    resourceId long 资源ID
    resourceName string 资源名称
    resourceType string 资源类型：SCENIC/RESTAURANT/HOTEL/ACTIVITY/PRODUCT
    sortOrder int 排序
  sortOrder int 排序
  source string 来源
  status int 状态：0=草稿，1=已发布，2=已下架
  subtitle string 副标题
  summary string 摘要
  tags 攻略标签[] 标签列表
    createdAt string 创建时间
    tagColor string 标签颜色
    tagId long 标签ID
    tagName string 标签名称
    tagType int 标签类型：0=系统管理，1=自定义
    useCount int 使用次数
  title string 标题
  updatedAt string 更新时间
  viewCount int 浏览量
message string 响应消息

DELETE /admin/guide/article/{articleId}

删除文章

软删除攻略文章，同时清除文章的标签关联。

权限：需管理员登录。

路径参数

参数 类型 必填 说明
articleId integer 是 articleId

响应 统一响应结果«Void»

PUT /admin/guide/article/{articleId}/recommend

设置推荐

设置/取消文章推荐。推荐文章会在小程序首页和推荐列表中优先展示

路径参数

参数 类型 必填 说明
articleId integer 是 articleId

请求体 RecommendRequest

字段 类型 必填 说明
isRecommend int 是 是否推荐：0=否，1=是

响应 统一响应结果«Void»

PUT /admin/guide/article/{articleId}/status

发布/下架

切换文章发布状态。发布后小程序端可见，下架后小程序端不再展示但管理端仍可查看

关联字典：

  • wiki_status：文章状态（状态切换）

路径参数

参数 类型 必填 说明
articleId integer 是 articleId

请求体 StatusRequest

字段 类型 必填 说明
status int 是 状态值

响应 统一响应结果«Void»

PUT /admin/guide/article/{articleId}/top

设置置顶

设置/取消文章置顶。置顶文章在分类列表中始终排在最前面

路径参数

参数 类型 必填 说明
articleId integer 是 articleId

请求体 TopRequest

字段 类型 必填 说明
isTop int 是 是否置顶：0=否，1=是

响应 统一响应结果«Void»

攻略标签管理

POST /admin/guide/tag

创建标签

创建攻略系统标签，标签名称不可重复。创建后可用于文章分类和筛选。

权限：需管理员登录。

请求体 TagCreateRequest

字段 类型 必填 说明
tagColor string 标签颜色（十六进制）
tagName string 是 标签名称
tagType int 标签类型：0=系统管理，1=自定义（默认0）

响应 统一响应结果«攻略标签»

字段 类型 必填 说明
code int 状态码
data 攻略标签 响应数据
  createdAt string 创建时间
  tagColor string 标签颜色
  tagId long 标签ID
  tagName string 标签名称
  tagType int 标签类型：0=系统管理，1=自定义
  useCount int 使用次数
message string 响应消息

GET /admin/guide/tag/all

所有标签列表

返回全部标签（含系统标签和用户自定义标签），用于文章编辑时的标签选择器

响应 统一响应结果«List«攻略标签»»

字段 类型 必填 说明
code int 状态码
data 攻略标签[] 响应数据
  createdAt string 创建时间
  tagColor string 标签颜色
  tagId long 标签ID
  tagName string 标签名称
  tagType int 标签类型：0=系统管理，1=自定义
  useCount int 使用次数
message string 响应消息

PUT /admin/guide/tag/article/{articleId}

更新文章标签

全量替换文章的标签关联，传入新的标签ID列表（空数组表示清除所有标签）

路径参数

参数 类型 必填 说明
articleId integer 是 articleId

请求体 ArticleTagUpdateRequest

字段 类型 必填 说明
tagIds long[] 是 标签ID列表

响应 统一响应结果«Void»

GET /admin/guide/tag/managed

系统标签列表

返回管理员创建的系统标签（不含用户自定义标签），用于标签管理页

响应 统一响应结果«List«攻略标签»»

字段 类型 必填 说明
code int 状态码
data 攻略标签[] 响应数据
  createdAt string 创建时间
  tagColor string 标签颜色
  tagId long 标签ID
  tagName string 标签名称
  tagType int 标签类型：0=系统管理，1=自定义
  useCount int 使用次数
message string 响应消息

PUT /admin/guide/tag/{tagId}

更新标签

更新标签名称。标签名称不可与其他已有标签重复。

权限：需管理员登录。

路径参数

参数 类型 必填 说明
tagId integer 是 tagId

请求体 TagUpdateRequest

字段 类型 必填 说明
tagColor string 标签颜色（十六进制）
tagName string 标签名称

响应 统一响应结果«攻略标签»

字段 类型 必填 说明
code int 状态码
data 攻略标签 响应数据
  createdAt string 创建时间
  tagColor string 标签颜色
  tagId long 标签ID
  tagName string 标签名称
  tagType int 标签类型：0=系统管理，1=自定义
  useCount int 使用次数
message string 响应消息

DELETE /admin/guide/tag/{tagId}

删除标签

删除标签并自动解除与所有文章的关联关系。

权限：需管理员登录。

路径参数

参数 类型 必填 说明
tagId integer 是 tagId

响应 统一响应结果«Void»