hl-api-changelog/api-docs/hl-guide-service.json
2026-03-17 09:21:07 +08:00

2364 行
63 KiB
JSON

此文件含有模棱两可的 Unicode 字符

此文件含有可能会与其他字符混淆的 Unicode 字符。 如果您是想特意这样的,可以安全地忽略该警告。 使用 Escape 按钮显示他们。

{
"swagger": "2.0",
"info": {
"title": "攻略服务",
"version": "1.0.0"
},
"basePath": "/",
"paths": {
"/admin/guide/category": {
"post": {
"tags": [
"攻略分类管理"
],
"summary": "创建分类",
"description": "创建攻略分类,分类名称不可重复。创建后默认启用,排序值越小越靠前。\n\n**权限**:需管理员登录。",
"operationId": "createCategoryUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "CategoryCreateRequest",
"$ref": "#/definitions/CategoryCreateRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略分类»",
"$ref": "#/definitions/统一响应结果«攻略分类»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略分类»",
"$ref": "#/definitions/统一响应结果«攻略分类»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/category/enabled": {
"get": {
"tags": [
"攻略分类管理"
],
"summary": "启用的分类列表",
"description": "仅返回状态为启用的分类,创建文章时用于选择分类",
"operationId": "listEnabledCategoriesUsingGET",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«List«攻略分类»»",
"$ref": "#/definitions/统一响应结果«List«攻略分类»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«List«攻略分类»»",
"$ref": "#/definitions/统一响应结果«List«攻略分类»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/category/list": {
"get": {
"tags": [
"攻略分类管理"
],
"summary": "分类列表",
"description": "返回全部攻略分类(含启用和停用),按排序值升序排列\n\n**关联字典**\n- common_status通用状态列表显示,ACTIVE=启用/INACTIVE=停用)",
"operationId": "listCategoriesUsingGET",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«List«攻略分类»»",
"$ref": "#/definitions/统一响应结果«List«攻略分类»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«List«攻略分类»»",
"$ref": "#/definitions/统一响应结果«List«攻略分类»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/category/{categoryId}": {
"put": {
"tags": [
"攻略分类管理"
],
"summary": "更新分类",
"description": "更新攻略分类的名称、图标、描述等信息。\n\n**权限**:需管理员登录。",
"operationId": "updateCategoryUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "categoryId",
"in": "path",
"description": "categoryId",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "CategoryUpdateRequest",
"$ref": "#/definitions/CategoryUpdateRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略分类»",
"$ref": "#/definitions/统一响应结果«攻略分类»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略分类»",
"$ref": "#/definitions/统一响应结果«攻略分类»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
},
"delete": {
"tags": [
"攻略分类管理"
],
"summary": "删除分类",
"description": "删除分类前需确保分类下无文章,否则删除失败",
"operationId": "deleteCategoryUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "categoryId",
"in": "path",
"description": "categoryId",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/category/{categoryId}/sort": {
"put": {
"tags": [
"攻略分类管理"
],
"summary": "更新分类排序",
"description": "更新分类的排序值,排序值越小越靠前。影响小程序端分类导航的展示顺序。\n\n**权限**:需管理员登录。",
"operationId": "updateSortUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "categoryId",
"in": "path",
"description": "categoryId",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "CategorySortRequest",
"$ref": "#/definitions/CategorySortRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/category/{categoryId}/status": {
"put": {
"tags": [
"攻略分类管理"
],
"summary": "更新分类状态",
"description": "启用或停用分类。停用后该分类下的文章不会在小程序端展示,但不影响已有文章\n\n**关联字典**\n- common_status通用状态状态切换,ACTIVE=启用/INACTIVE=停用)",
"operationId": "updateStatusUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "categoryId",
"in": "path",
"description": "categoryId",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "StatusRequest",
"$ref": "#/definitions/StatusRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/article": {
"post": {
"tags": [
"攻略文章管理"
],
"summary": "创建文章",
"description": "创建攻略文章,需指定分类。创建后默认为草稿状态,需手动发布后小程序端才可见。\n\n**权限**:需管理员登录。\n\n**关联字典**\n- wiki_status文章状态创建后默认DRAFT",
"operationId": "createArticleUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "ArticleCreateRequest",
"$ref": "#/definitions/ArticleCreateRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略文章详情»",
"$ref": "#/definitions/统一响应结果«攻略文章详情»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略文章详情»",
"$ref": "#/definitions/统一响应结果«攻略文章详情»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/article/list": {
"get": {
"tags": [
"攻略文章管理"
],
"summary": "文章列表",
"description": "分页查询攻略文章,支持按分类、状态、关键词筛选\n\n**关联字典**\n- wiki_status文章状态列表筛选+显示)",
"operationId": "listArticlesUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "categoryId",
"in": "query",
"description": "分类ID",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "isRecommend",
"in": "query",
"description": "是否推荐0=否,1=是",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "isTop",
"in": "query",
"description": "是否置顶0=否,1=是",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "keyword",
"in": "query",
"description": "关键词(搜索标题/摘要)",
"required": false,
"type": "string"
},
{
"name": "orderBy",
"in": "query",
"description": "排序字段sortOrder/publishTime/viewCount/createdAt默认createdAt",
"required": false,
"type": "string"
},
{
"name": "orderDir",
"in": "query",
"description": "排序方向asc/desc默认desc",
"required": false,
"type": "string"
},
{
"name": "page",
"in": "query",
"description": "页码默认1",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "每页数量默认20,最大100",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "status",
"in": "query",
"description": "状态0=草稿,1=已发布,2=已下架",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«分页结果«攻略文章列表项»»",
"$ref": "#/definitions/统一响应结果«分页结果«攻略文章列表项»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«分页结果«攻略文章列表项»»",
"$ref": "#/definitions/统一响应结果«分页结果«攻略文章列表项»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/article/{articleId}": {
"get": {
"tags": [
"攻略文章管理"
],
"summary": "文章详情",
"description": "**关联字典**\n- wiki_status文章状态显示",
"operationId": "getArticleUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "articleId",
"in": "path",
"description": "articleId",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略文章详情»",
"$ref": "#/definitions/统一响应结果«攻略文章详情»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略文章详情»",
"$ref": "#/definitions/统一响应结果«攻略文章详情»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
},
"put": {
"tags": [
"攻略文章管理"
],
"summary": "更新文章",
"description": "更新攻略文章的标题、内容、封面图、分类等信息。已发布的文章更新后立即生效。\n\n**权限**:需管理员登录。",
"operationId": "updateArticleUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "articleId",
"in": "path",
"description": "articleId",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "ArticleUpdateRequest",
"$ref": "#/definitions/ArticleUpdateRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略文章详情»",
"$ref": "#/definitions/统一响应结果«攻略文章详情»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略文章详情»",
"$ref": "#/definitions/统一响应结果«攻略文章详情»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
},
"delete": {
"tags": [
"攻略文章管理"
],
"summary": "删除文章",
"description": "软删除攻略文章,同时清除文章的标签关联。\n\n**权限**:需管理员登录。",
"operationId": "deleteArticleUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "articleId",
"in": "path",
"description": "articleId",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/article/{articleId}/recommend": {
"put": {
"tags": [
"攻略文章管理"
],
"summary": "设置推荐",
"description": "设置/取消文章推荐。推荐文章会在小程序首页和推荐列表中优先展示",
"operationId": "updateRecommendUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "articleId",
"in": "path",
"description": "articleId",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "RecommendRequest",
"$ref": "#/definitions/RecommendRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/article/{articleId}/status": {
"put": {
"tags": [
"攻略文章管理"
],
"summary": "发布/下架",
"description": "切换文章发布状态。发布后小程序端可见,下架后小程序端不再展示但管理端仍可查看\n\n**关联字典**\n- wiki_status文章状态状态切换",
"operationId": "updateStatusUsingPUT_1",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "articleId",
"in": "path",
"description": "articleId",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "StatusRequest",
"$ref": "#/definitions/StatusRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/article/{articleId}/top": {
"put": {
"tags": [
"攻略文章管理"
],
"summary": "设置置顶",
"description": "设置/取消文章置顶。置顶文章在分类列表中始终排在最前面",
"operationId": "updateTopUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "articleId",
"in": "path",
"description": "articleId",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "TopRequest",
"$ref": "#/definitions/TopRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/tag": {
"post": {
"tags": [
"攻略标签管理"
],
"summary": "创建标签",
"description": "创建攻略系统标签,标签名称不可重复。创建后可用于文章分类和筛选。\n\n**权限**:需管理员登录。",
"operationId": "createTagUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "TagCreateRequest",
"$ref": "#/definitions/TagCreateRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略标签»",
"$ref": "#/definitions/统一响应结果«攻略标签»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略标签»",
"$ref": "#/definitions/统一响应结果«攻略标签»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/tag/all": {
"get": {
"tags": [
"攻略标签管理"
],
"summary": "所有标签列表",
"description": "返回全部标签(含系统标签和用户自定义标签),用于文章编辑时的标签选择器",
"operationId": "listAllTagsUsingGET",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«List«攻略标签»»",
"$ref": "#/definitions/统一响应结果«List«攻略标签»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«List«攻略标签»»",
"$ref": "#/definitions/统一响应结果«List«攻略标签»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/tag/article/{articleId}": {
"put": {
"tags": [
"攻略标签管理"
],
"summary": "更新文章标签",
"description": "全量替换文章的标签关联,传入新的标签ID列表空数组表示清除所有标签",
"operationId": "updateArticleTagsUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "articleId",
"in": "path",
"description": "articleId",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "ArticleTagUpdateRequest",
"$ref": "#/definitions/ArticleTagUpdateRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/tag/managed": {
"get": {
"tags": [
"攻略标签管理"
],
"summary": "系统标签列表",
"description": "返回管理员创建的系统标签(不含用户自定义标签),用于标签管理页",
"operationId": "listManagedTagsUsingGET",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«List«攻略标签»»",
"$ref": "#/definitions/统一响应结果«List«攻略标签»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«List«攻略标签»»",
"$ref": "#/definitions/统一响应结果«List«攻略标签»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/guide/tag/{tagId}": {
"put": {
"tags": [
"攻略标签管理"
],
"summary": "更新标签",
"description": "更新标签名称。标签名称不可与其他已有标签重复。\n\n**权限**:需管理员登录。",
"operationId": "updateTagUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "TagUpdateRequest",
"$ref": "#/definitions/TagUpdateRequest"
}
},
{
"name": "tagId",
"in": "path",
"description": "tagId",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略标签»",
"$ref": "#/definitions/统一响应结果«攻略标签»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«攻略标签»",
"$ref": "#/definitions/统一响应结果«攻略标签»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
},
"delete": {
"tags": [
"攻略标签管理"
],
"summary": "删除标签",
"description": "删除标签并自动解除与所有文章的关联关系。\n\n**权限**:需管理员登录。",
"operationId": "deleteTagUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "tagId",
"in": "path",
"description": "tagId",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"originalRef": "统一响应结果«Void»",
"$ref": "#/definitions/统一响应结果«Void»"
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"deprecated": false,
"x-order": "2147483647"
}
}
},
"definitions": {
"CategoryCreateRequest": {
"type": "object",
"required": [
"categoryName"
],
"properties": {
"categoryName": {
"type": "string",
"description": "分类名称"
},
"coverMaterialId": {
"type": "integer",
"format": "int64",
"description": "封面素材ID"
},
"coverUrl": {
"type": "string",
"description": "封面URL"
},
"description": {
"type": "string",
"description": "描述"
},
"icon": {
"type": "string",
"description": "图标"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"description": "排序默认0"
}
},
"title": "CategoryCreateRequest"
},
"CategorySortRequest": {
"type": "object",
"required": [
"sortOrder"
],
"properties": {
"sortOrder": {
"type": "integer",
"format": "int32",
"description": "排序值"
}
},
"title": "CategorySortRequest"
},
"CategoryUpdateRequest": {
"type": "object",
"properties": {
"categoryName": {
"type": "string",
"description": "分类名称"
},
"coverMaterialId": {
"type": "integer",
"format": "int64",
"description": "封面素材ID"
},
"coverUrl": {
"type": "string",
"description": "封面URL"
},
"description": {
"type": "string",
"description": "描述"
},
"icon": {
"type": "string",
"description": "图标"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"description": "排序"
}
},
"title": "CategoryUpdateRequest"
},
"StatusRequest": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "状态值"
}
},
"title": "StatusRequest"
},
"攻略分类": {
"type": "object",
"properties": {
"articleCount": {
"type": "integer",
"format": "int32",
"description": "文章数量"
},
"categoryId": {
"type": "integer",
"format": "int64",
"description": "分类ID"
},
"categoryName": {
"type": "string",
"description": "分类名称"
},
"coverMaterialId": {
"type": "integer",
"format": "int64",
"description": "封面素材ID"
},
"coverUrl": {
"type": "string",
"description": "封面URL"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "创建时间"
},
"description": {
"type": "string",
"description": "描述"
},
"icon": {
"type": "string",
"description": "图标"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"description": "排序"
},
"status": {
"type": "integer",
"format": "int32",
"description": "状态0=禁用,1=启用"
}
},
"title": "攻略分类"
},
"统一响应结果«List«攻略分类»»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"type": "array",
"description": "响应数据",
"items": {
"originalRef": "攻略分类",
"$ref": "#/definitions/攻略分类"
}
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«List«攻略分类»»"
},
"统一响应结果«Void»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«Void»"
},
"统一响应结果«攻略分类»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"description": "响应数据",
"originalRef": "攻略分类",
"$ref": "#/definitions/攻略分类"
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«攻略分类»"
},
"ArticleCreateRequest": {
"type": "object",
"required": [
"categoryId",
"title"
],
"properties": {
"authorName": {
"type": "string",
"description": "作者名称"
},
"bannerMaterialIds": {
"type": "array",
"description": "轮播图素材ID列表",
"items": {
"type": "integer",
"format": "int64"
}
},
"categoryId": {
"type": "integer",
"format": "int64",
"description": "分类ID"
},
"content": {
"type": "string",
"description": "正文内容"
},
"coverMaterialId": {
"type": "integer",
"format": "int64",
"description": "封面素材ID"
},
"coverUrl": {
"type": "string",
"description": "封面URL"
},
"resources": {
"type": "array",
"description": "关联资源列表",
"items": {
"originalRef": "ArticleResourceItem",
"$ref": "#/definitions/ArticleResourceItem"
}
},
"sortOrder": {
"type": "integer",
"format": "int32",
"description": "排序默认0"
},
"source": {
"type": "string",
"description": "来源"
},
"subtitle": {
"type": "string",
"description": "副标题"
},
"summary": {
"type": "string",
"description": "摘要"
},
"tagIds": {
"type": "array",
"description": "标签ID列表",
"items": {
"type": "integer",
"format": "int64"
}
},
"title": {
"type": "string",
"description": "标题"
}
},
"title": "ArticleCreateRequest"
},
"ArticleResourceItem": {
"type": "object",
"required": [
"resourceId",
"resourceName",
"resourceType"
],
"properties": {
"resourceId": {
"type": "integer",
"format": "int64",
"description": "资源ID"
},
"resourceName": {
"type": "string",
"description": "资源名称"
},
"resourceType": {
"type": "string",
"description": "资源类型SCENIC/RESTAURANT/HOTEL/ACTIVITY/PRODUCT"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"description": "排序"
}
},
"title": "ArticleResourceItem"
},
"ArticleUpdateRequest": {
"type": "object",
"properties": {
"authorName": {
"type": "string",
"description": "作者名称"
},
"bannerMaterialIds": {
"type": "array",
"description": "轮播图素材ID列表",
"items": {
"type": "integer",
"format": "int64"
}
},
"categoryId": {
"type": "integer",
"format": "int64",
"description": "分类ID"
},
"content": {
"type": "string",
"description": "正文内容"
},
"coverMaterialId": {
"type": "integer",
"format": "int64",
"description": "封面素材ID"
},
"coverUrl": {
"type": "string",
"description": "封面URL"
},
"resources": {
"type": "array",
"description": "关联资源列表",
"items": {
"originalRef": "ArticleResourceItem",
"$ref": "#/definitions/ArticleResourceItem"
}
},
"sortOrder": {
"type": "integer",
"format": "int32",
"description": "排序"
},
"source": {
"type": "string",
"description": "来源"
},
"subtitle": {
"type": "string",
"description": "副标题"
},
"summary": {
"type": "string",
"description": "摘要"
},
"tagIds": {
"type": "array",
"description": "标签ID列表",
"items": {
"type": "integer",
"format": "int64"
}
},
"title": {
"type": "string",
"description": "标题"
}
},
"title": "ArticleUpdateRequest"
},
"RecommendRequest": {
"type": "object",
"required": [
"isRecommend"
],
"properties": {
"isRecommend": {
"type": "integer",
"format": "int32",
"description": "是否推荐0=否,1=是"
}
},
"title": "RecommendRequest"
},
"TopRequest": {
"type": "object",
"required": [
"isTop"
],
"properties": {
"isTop": {
"type": "integer",
"format": "int32",
"description": "是否置顶0=否,1=是"
}
},
"title": "TopRequest"
},
"分页结果«攻略文章列表项»": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "当前页码"
},
"pageSize": {
"type": "integer",
"format": "int32",
"example": 20,
"description": "每页条数"
},
"records": {
"type": "array",
"description": "数据列表",
"items": {
"originalRef": "攻略文章列表项",
"$ref": "#/definitions/攻略文章列表项"
}
},
"total": {
"type": "integer",
"format": "int32",
"example": 100,
"description": "总记录数"
}
},
"title": "分页结果«攻略文章列表项»"
},
"攻略文章列表项": {
"type": "object",
"properties": {
"articleId": {
"type": "integer",
"format": "int64",
"description": "文章ID"
},
"categoryId": {
"type": "integer",
"format": "int64",
"description": "分类ID"
},
"categoryName": {
"type": "string",
"description": "分类名称"
},
"coverUrl": {
"type": "string",
"description": "封面URL"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "创建时间"
},
"isRecommend": {
"type": "integer",
"format": "int32",
"description": "是否推荐0=否,1=是"
},
"isTop": {
"type": "integer",
"format": "int32",
"description": "是否置顶0=否,1=是"
},
"publishTime": {
"type": "string",
"format": "date-time",
"description": "发布时间"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"description": "排序"
},
"status": {
"type": "integer",
"format": "int32",
"description": "状态0=草稿,1=已发布,2=已下架"
},
"summary": {
"type": "string",
"description": "摘要"
},
"tags": {
"type": "array",
"description": "标签列表",
"items": {
"originalRef": "攻略标签",
"$ref": "#/definitions/攻略标签"
}
},
"title": {
"type": "string",
"description": "标题"
},
"viewCount": {
"type": "integer",
"format": "int32",
"description": "浏览量"
}
},
"title": "攻略文章列表项"
},
"攻略文章详情": {
"type": "object",
"properties": {
"articleId": {
"type": "integer",
"format": "int64",
"description": "文章ID"
},
"authorName": {
"type": "string",
"description": "作者名称"
},
"bannerMaterialIds": {
"type": "array",
"description": "轮播图素材ID列表",
"items": {
"type": "integer",
"format": "int64"
}
},
"categoryId": {
"type": "integer",
"format": "int64",
"description": "分类ID"
},
"categoryName": {
"type": "string",
"description": "分类名称"
},
"content": {
"type": "string",
"description": "正文内容"
},
"coverMaterialId": {
"type": "integer",
"format": "int64",
"description": "封面素材ID"
},
"coverUrl": {
"type": "string",
"description": "封面URL"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "创建时间"
},
"favoriteCount": {
"type": "integer",
"format": "int32",
"description": "收藏数"
},
"isRecommend": {
"type": "integer",
"format": "int32",
"description": "是否推荐0=否,1=是"
},
"isTop": {
"type": "integer",
"format": "int32",
"description": "是否置顶0=否,1=是"
},
"likeCount": {
"type": "integer",
"format": "int32",
"description": "点赞数"
},
"publishTime": {
"type": "string",
"format": "date-time",
"description": "发布时间"
},
"resources": {
"type": "array",
"description": "关联资源列表",
"items": {
"originalRef": "文章关联资源",
"$ref": "#/definitions/文章关联资源"
}
},
"sortOrder": {
"type": "integer",
"format": "int32",
"description": "排序"
},
"source": {
"type": "string",
"description": "来源"
},
"status": {
"type": "integer",
"format": "int32",
"description": "状态0=草稿,1=已发布,2=已下架"
},
"subtitle": {
"type": "string",
"description": "副标题"
},
"summary": {
"type": "string",
"description": "摘要"
},
"tags": {
"type": "array",
"description": "标签列表",
"items": {
"originalRef": "攻略标签",
"$ref": "#/definitions/攻略标签"
}
},
"title": {
"type": "string",
"description": "标题"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "更新时间"
},
"viewCount": {
"type": "integer",
"format": "int32",
"description": "浏览量"
}
},
"title": "攻略文章详情"
},
"攻略标签": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"description": "创建时间"
},
"tagColor": {
"type": "string",
"description": "标签颜色"
},
"tagId": {
"type": "integer",
"format": "int64",
"description": "标签ID"
},
"tagName": {
"type": "string",
"description": "标签名称"
},
"tagType": {
"type": "integer",
"format": "int32",
"description": "标签类型0=系统管理,1=自定义"
},
"useCount": {
"type": "integer",
"format": "int32",
"description": "使用次数"
}
},
"title": "攻略标签"
},
"文章关联资源": {
"type": "object",
"properties": {
"resourceId": {
"type": "integer",
"format": "int64",
"description": "资源ID"
},
"resourceName": {
"type": "string",
"description": "资源名称"
},
"resourceType": {
"type": "string",
"description": "资源类型SCENIC/RESTAURANT/HOTEL/ACTIVITY/PRODUCT"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"description": "排序"
}
},
"title": "文章关联资源"
},
"统一响应结果«分页结果«攻略文章列表项»»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"description": "响应数据",
"originalRef": "分页结果«攻略文章列表项»",
"$ref": "#/definitions/分页结果«攻略文章列表项»"
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«分页结果«攻略文章列表项»»"
},
"统一响应结果«攻略文章详情»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"description": "响应数据",
"originalRef": "攻略文章详情",
"$ref": "#/definitions/攻略文章详情"
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«攻略文章详情»"
},
"ArticleTagUpdateRequest": {
"type": "object",
"required": [
"tagIds"
],
"properties": {
"tagIds": {
"type": "array",
"description": "标签ID列表",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"title": "ArticleTagUpdateRequest"
},
"TagCreateRequest": {
"type": "object",
"required": [
"tagName"
],
"properties": {
"tagColor": {
"type": "string",
"description": "标签颜色(十六进制)"
},
"tagName": {
"type": "string",
"description": "标签名称"
},
"tagType": {
"type": "integer",
"format": "int32",
"description": "标签类型0=系统管理,1=自定义默认0"
}
},
"title": "TagCreateRequest"
},
"TagUpdateRequest": {
"type": "object",
"properties": {
"tagColor": {
"type": "string",
"description": "标签颜色(十六进制)"
},
"tagName": {
"type": "string",
"description": "标签名称"
}
},
"title": "TagUpdateRequest"
},
"统一响应结果«List«攻略标签»»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"type": "array",
"description": "响应数据",
"items": {
"originalRef": "攻略标签",
"$ref": "#/definitions/攻略标签"
}
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«List«攻略标签»»"
},
"统一响应结果«攻略标签»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"description": "响应数据",
"originalRef": "攻略标签",
"$ref": "#/definitions/攻略标签"
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«攻略标签»"
}
}
}