HelloWorld
登录

四、飞鹅后端管理系统API接口文档

飞鹅官方账号

2024-08-24

1317 1 0

接口列表

1. 服务健康检查

  • 请求方法: GET
  • 请求 URL: /api/health

请求参数

无

返回结果

1{
2    "code": 1,
3    "message": "success"
4}

2. 用户登录

  • 请求方法: POST
  • 请求 URL: /api/admin/access/login

请求参数（form表单）

参数名称类型描述是否必需
usernamestring账号是
passwordstring密码是

返回结果

1{
2    "code": 1,
3    "data": {
4        "token": "d0629855ca6095f8ca7ad85baec22cea"
5    },
6    "message": "登录成功"
7}

3. 用户登出

  • 请求方法: POST
  • 请求 URL: /api/admin/access/logout

请求参数

无

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "退出成功"
5}

4. 创建博客

  • 请求方法: POST
  • 请求 URL: /api/admin/blog/createBlog

请求参数（form表单）

字段名类型描述是否必须
titlestring博客标题是
introstring博客简介否
contentstring博客内容否
htmlstringHTML 格式的博客内容否
tagsstring标签列表否
thumbnailstring缩略图 URL否
isHtmlint内容来源：0：md 编辑器产生的内容，1：富文本编辑器产生的内容是
isTopint是否置顶：0：不置顶，1：置顶是
cateIdint64博客分类 枚举是

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "创建成功"
5}

5. 更新博客

  • 请求方法: POST
  • 请求 URL: /api/admin/blog/updateBlog

请求参数（form表单）

字段名类型描述是否必须
idint64博客ID是
titlestring博客标题是
introstring博客简介否
contentstring博客内容否
htmlstringHTML 格式的博客内容否
tagsstring标签列表否
thumbnailstring缩略图 URL否
isHtmlint内容来源：0：md 编辑器产生的内容，1：富文本编辑器产生的内容是
isTopint是否置顶：0：不置顶，1：置顶是
cateIdint64博客分类 枚举是

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "更新成功"
5}

6. 博客状态变更

  • 请求方法: POST
  • 请求 URL: /api/admin/blog/updateBlogStatus

请求参数（form表单）

字段名类型描述是否必须
idint64博客ID是
statusint博客的状态值：10-已创建；20-已下架；30-已发布是

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "更新成功"
5}

7. 根据博客状态获取博客列表

  • 请求方法: POST
  • 请求 URL: /api/admin/blog/getBlogListByStatus

请求参数（form表单）

字段名类型描述是否必须
pageNumint分页页码是
pageSizeint分页大小是
statusint博客的状态值：10-已创建；20-已下架；30-已发布是

返回结果

1{
2    "code": 1,
3    "data": {
4        "count": 1122,
5        "list": [
6            {
7                "id": 1, // 博客 ID
8                "title": "Sample Blog Title", // 博客的标题
9                "intro": "This is a brief introduction to the blog.", // 博客的简介
10                "content": "This is the content written in Markdown format.", // md 编辑器产生的内容时，对应的 md 的内容
11                "html": "<p>This is the HTML content generated from Markdown.</p>", // md 编辑器产生的内容时，对应的生成的 HTML
12                "isHtml": 1, // 0：md 编辑器产生的内容，1：富文本编辑器产生的内容
13                "isTop": 0, // 是否置顶：0：不置顶，1：置顶
14                "readCount": 1024, // 阅读数
15                "createTime": "2024-08-22T15:30:00Z", // 创建时间
16                "updateTime": "2024-08-22T15:45:00Z", // 更新时间
17                "publishTime": "2024-08-22T16:00:00Z", // 发布时间
18                "thumbnail": "https://example.com/thumbnail.jpg", // 缩略图， 是一个 URL
19                "status": "published", // 博客状态
20                "cateId": 4, // 博客分类枚举值
21                "tags": "golang,struct,example" // 标签，英文逗号分隔，如："并发,线程,Java"
22            }
23        ]
24    },
25    "message": "获取数据成功"
26}

8. 根据关键字搜索获取博客列表

  • 请求方法: POST
  • 请求 URL: /api/admin/blog/getBlogListByWord

请求参数（form表单）

字段名类型描述是否必须
pageNumint分页页码是
pageSizeint分页大小是
wordstring关键字是

返回结果

1{
2    "code": 1,
3    "data": {
4        "count": 1122,
5        "list": [
6            {
7                "id": 1, // 博客 ID
8                "title": "Sample Blog Title", // 博客的标题
9                "intro": "This is a brief introduction to the blog.", // 博客的简介
10                "content": "This is the content written in Markdown format.", // md 编辑器产生的内容时，对应的 md 的内容
11                "html": "<p>This is the HTML content generated from Markdown.</p>", // md 编辑器产生的内容时，对应的生成的 HTML
12                "isHtml": 1, // 0：md 编辑器产生的内容，1：富文本编辑器产生的内容
13                "isTop": 0, // 是否置顶：0：不置顶，1：置顶
14                "readCount": 1024, // 阅读数
15                "createTime": "2024-08-22T15:30:00Z", // 创建时间
16                "updateTime": "2024-08-22T15:45:00Z", // 更新时间
17                "publishTime": "2024-08-22T16:00:00Z", // 发布时间
18                "thumbnail": "https://example.com/thumbnail.jpg", // 缩略图， 是一个 URL
19                "status": "published", // 博客状态
20                "cateId": 4, // 博客分类枚举值
21                "tags": "golang,struct,example" // 标签，英文逗号分隔，如："并发,线程,Java"
22            }
23        ]
24    },
25    "message": "获取数据成功"
26}

9. 搜索博客

  • 请求方法: POST
  • 请求 URL: /api/admin/blog/searchBlog

请求参数（form表单）

字段名类型描述是否必须
pageNumint分页页码是
pageSizeint分页大小是
wordstring关键字否
statusint博客的状态值：10-已创建；20-已下架；30-已发布否

返回结果

1{
2    "code": 1,
3    "data": {
4        "count": 1122,
5        "list": [
6            {
7                "id": 1, // 博客 ID
8                "title": "Sample Blog Title", // 博客的标题
9                "intro": "This is a brief introduction to the blog.", // 博客的简介
10                "content": "This is the content written in Markdown format.", // md 编辑器产生的内容时，对应的 md 的内容
11                "html": "<p>This is the HTML content generated from Markdown.</p>", // md 编辑器产生的内容时，对应的生成的 HTML
12                "isHtml": 1, // 0：md 编辑器产生的内容，1：富文本编辑器产生的内容
13                "isTop": 0, // 是否置顶：0：不置顶，1：置顶
14                "readCount": 1024, // 阅读数
15                "createTime": "2024-08-22T15:30:00Z", // 创建时间
16                "updateTime": "2024-08-22T15:45:00Z", // 更新时间
17                "publishTime": "2024-08-22T16:00:00Z", // 发布时间
18                "thumbnail": "https://example.com/thumbnail.jpg", // 缩略图， 是一个 URL
19                "status": "published", // 博客状态
20                "cateId": 4, // 博客分类枚举值
21                "tags": "golang,struct,example" // 标签，英文逗号分隔，如："并发,线程,Java"
22            }
23        ]
24    },
25    "message": "获取数据成功"
26}

10. 获取博客详情

  • 请求方法: POST
  • 请求 URL: /api/admin/blog/getBlogDetail

请求参数（form表单）

字段名类型描述是否必须
idint64博客ID是

返回结果

1{
2    "code": 1,
3    "data": {
4        "id": 1, // 博客 ID
5        "title": "Sample Blog Title", // 博客的标题
6        "intro": "This is a brief introduction to the blog.", // 博客的简介
7        "content": "This is the content written in Markdown format.", // md 编辑器产生的内容时，对应的 md 的内容
8        "html": "<p>This is the HTML content generated from Markdown.</p>", // md 编辑器产生的内容时，对应的生成的 HTML
9        "isHtml": 1, // 0：md 编辑器产生的内容，1：富文本编辑器产生的内容
10        "isTop": 0, // 是否置顶：0：不置顶，1：置顶
11        "readCount": 1024, // 阅读数
12        "createTime": "2024-08-22T15:30:00Z", // 创建时间
13        "updateTime": "2024-08-22T15:45:00Z", // 更新时间
14        "publishTime": "2024-08-22T16:00:00Z", // 发布时间
15        "thumbnail": "https://example.com/thumbnail.jpg", // 缩略图， 是一个 URL
16        "status": "published", // 博客状态
17        "cateId": 4, // 博客分类枚举值
18        "tags": "golang,struct,example" // 标签，英文逗号分隔，如："并发,线程,Java"
19    },
20    "message": "获取博客成功"
21}

11. 创建友链

  • 请求方法: POST
  • 请求 URL: /api/admin/link/create

请求参数（form表单）

字段名类型描述是否必须
titlestring名称是
urlstringURL是
seqint序号否
validTimeint64有效时间（UNIX 时间戳）否
remarkstring备注否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "添加成功"
5}

12. 修改友链

  • 请求方法: POST
  • 请求 URL: /api/admin/link/update

请求参数（form表单）

字段名类型描述是否必须
idint64友链ID是
titlestring名称否
urlstringURL否
seqint序号否
validTimeint64有效时间（UNIX 时间戳）否
remarkstring备注否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "更新成功"
5}

13. 获取友链信息

  • 请求方法: POST
  • 请求 URL: /api/admin/link/getLinkInfo

请求参数（form表单）

字段名类型描述是否必须
idint64友链ID是

返回结果

1{
2    "code": 1,
3    "data": {
4        "id": 1, // id
5        "title": "Sample Link Title", // 标题
6        "url": "https://example.com", // 链接到的 URL
7        "seq": 1, // 序号，从小到大排序
8        "createTime": "2024-08-22T15:30:00Z", // 创建时间
9        "updateTime": "2024-08-22T15:45:00Z", // 修改时间
10        "validTime": "2024-12-31T23:59:59Z", // 有效时间
11        "remark": "This is a sample remark.", // 备注
12        "status": 1 // 状态: 0-已下架；1-正常
13    },
14    "message": "获取成功"
15}

14. 获取友链

  • 请求方法: POST
  • 请求 URL: /api/admin/link/getLinkList

请求参数（form表单）

字段名类型描述是否必须
pageNumint分页页码是
pageSizeint分页大小是
statusint友链状态：0-已下架；1-已上架；-1-全部是

返回结果

1{
2    "code": 1,
3    "data": {
4        "count": 1122,
5        "list": [
6            {
7                "id": 1, // id
8                "title": "Sample Link Title", // 标题
9                "url": "https://example.com", // 链接到的 URL
10                "seq": 1, // 序号，从小到大排序
11                "createTime": "2024-08-22T15:30:00Z", // 创建时间
12                "updateTime": "2024-08-22T15:45:00Z", // 修改时间
13                "validTime": "2024-12-31T23:59:59Z", // 有效时间
14                "remark": "This is a sample remark.", // 备注
15                "status": 1 // 状态: 0-已下架；1-正常
16            }
17        ]
18    },
19    "message": "获取成功"
20}

15. 创建网站

  • 请求方法: POST
  • 请求 URL: /api/admin/site/createSite

请求参数（form表单）

字段名类型描述是否必须
titlestring网站名称否
introstring网站简介否
sloganstring个性签名否
coverstring网站背景图否
copyrightstring版权信息否
icpstring备案号否
extrastring额外的信息, json字符串,具体有哪些信息，暂未定否
statusint网站信息状态: 0-未启用；1-已启用否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "创建成功"
5}

16. 更新网站

  • 请求方法: POST
  • 请求 URL: /api/admin/site/updateSite

请求参数（form表单）

字段名类型描述是否必须
idint64网站ID是
titlestring网站名称否
introstring网站简介否
sloganstring个性签名否
coverstring网站背景图否
copyrightstring版权信息否
icpstring备案号否
extrastring额外的信息, json字符串,具体有哪些信息，暂未定否
statusint网站信息状态: 0-未启用；1-已启用否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "更新成功"
5}

17. 获取网站信息

  • 请求方法: POST
  • 请求 URL: /api/admin/site/getSiteInfoList

请求参数（form表单）

字段名类型描述是否必须
idint64网站ID是
titlestring网站名称否
introstring网站简介否
sloganstring个性签名否
coverstring网站背景图否
copyrightstring版权信息否
icpstring备案号否
extrastring额外的信息, json字符串,具体有哪些信息，暂未定否
statusint网站信息状态: 0-未启用；1-已启用否

返回结果

1{
2    "code": 1,
3    "data": {
4        "list": [
5            {
6                "id": 1, // id
7                "title": "Example Site Name", // 网站名称
8                "intro": "This is an example site description.", // 网站简介
9                "slogan": "Your Tagline Here", // 个性签名
10                "cover": "https://example.com/cover.jpg", // 网站背景图
11                "copyright": "© 2024 Example Company", // 版权信息
12                "icp": "ICP 12345678", // 备案号
13                "updateTime": "2024-08-22T15:30:00Z", // 更新时间
14                "extra": "{\"info\": \"Additional JSON data\"}", // 额外的信息, json字符串,具体有哪些信息，暂未定
15                "status": "1" // 网站信息状态: 0-未启用；1-已启用 
16            }
17        ]
18    },
19    "message": "获取数据成功"
20}

18. 获取在网站上展示的那一条

  • 请求方法: POST
  • 请求 URL: /api/admin/site/getUsedSiteInfo

请求参数（form表单）

字段名类型描述是否必须
idint64网站ID是
titlestring网站名称否
introstring网站简介否
sloganstring个性签名否
coverstring网站背景图否
copyrightstring版权信息否
icpstring备案号否
extrastring额外的信息, json字符串,具体有哪些信息，暂未定否
statusint网站信息状态: 0-未启用；1-已启用否

返回结果

1{
2    "code": 1,
3    "data": {
4        "id": 1, // id
5        "title": "Example Site Name", // 网站名称
6        "intro": "This is an example site description.", // 网站简介
7        "slogan": "Your Tagline Here", // 个性签名
8        "cover": "https://example.com/cover.jpg", // 网站背景图
9        "copyright": "© 2024 Example Company", // 版权信息
10        "icp": "ICP 12345678", // 备案号
11        "updateTime": "2024-08-22T15:30:00Z", // 更新时间
12        "extra": "{\"info\": \"Additional JSON data\"}", // 额外的信息, json字符串,具体有哪些信息，暂未定
13        "status": "1" // 网站信息状态: 0-未启用；1-已启用 
14    },
15    "message": "获取数据成功"
16}

19. 创建站长信息

  • 请求方法: POST
  • 请求 URL: /api/admin/site/createWebmasterInfo

请求参数（form表单）

字段名类型描述是否必须
introstring站长简介否
sloganstring站长个性签名否
nickerstring站长昵称否
avatarstring站长头像否
jobstring站长职业否
emailstring站长邮箱否
qqstring站长QQ号否
wechatstring站长微信二维码否
rewardCodestring站长打赏二维码否
statusint状态: 0-未启用；1-已启用否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "创建成功"
5}

20. 更新站长信息

  • 请求方法: POST
  • 请求 URL: /api/admin/site/updateWebmasterInfo

请求参数（form表单）

字段名类型描述是否必须
idint64站长ID是
introstring站长简介否
sloganstring站长个性签名否
nickerstring站长昵称否
avatarstring站长头像否
jobstring站长职业否
emailstring站长邮箱否
qqstring站长QQ号否
wechatstring站长微信二维码否
rewardCodestring站长打赏二维码否
statusint状态: 0-未启用；1-已启用否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "更新成功"
5}

21. 获取站长信息

  • 请求方法: POST
  • 请求 URL: /api/admin/site/getWebmasterInfo

请求参数

无

返回结果

1{
2    "code": 1,
3    "data": {
4        "id": 1234567890123456789, // id
5        "intro": "This is the webmaster's introduction.", // 站长简介
6        "slogan": "Webmaster's tagline", // 站长个性签名
7        "nicker": "webmaster_nickname", // 站长昵称
8        "avatar": "https://example.com/avatar.jpg", // 站长头像
9        "job": "Chief Web Officer", // 站长职业
10        "email": "webmaster@example.com", // 站长邮箱
11        "qq": "123456789", // 站长QQ号
12        "wechat": "https://example.com/wechat-qrcode.png", // 站长微信二维码
13        "rewardCode": "https://example.com/reward-qrcode.png", // 站长打赏二维码
14        "status": 1, // 状态 0-未启用；1-已启用
15        "updateTime": "2024-08-22T15:30:00Z" // 更新时间
16    },
17    "message": "获取数据成功"
18}

22. 获取站长信息

  • 请求方法: POST
  • 请求 URL: /api/admin/site/getWebmasterInfoList

请求参数

无

返回结果

1{
2    "code": 1,
3    "data": {
4        "list": [
5            {
6                "id": 1234567890123456789, // id
7                "intro": "This is the webmaster's introduction.", // 站长简介
8                "slogan": "Webmaster's tagline", // 站长个性签名
9                "nicker": "webmaster_nickname", // 站长昵称
10                "avatar": "https://example.com/avatar.jpg", // 站长头像
11                "job": "Chief Web Officer", // 站长职业
12                "email": "webmaster@example.com", // 站长邮箱
13                "qq": "123456789", // 站长QQ号
14                "wechat": "https://example.com/wechat-qrcode.png", // 站长微信二维码
15                "rewardCode": "https://example.com/reward-qrcode.png", // 站长打赏二维码
16                "status": 1, // 状态 0-未启用；1-已启用
17                "updateTime": "2024-08-22T15:30:00Z" // 更新时间
18            }
19        ]
20    },
21    "message": "获取数据成功"
22}

23. 创建博客分类

  • 请求方法: POST
  • 请求 URL: /api/admin/category/create

请求参数

字段名类型描述是否必须
namestring名称否
seqint序号，从小到大排序否
iconstring分类图标 icon 的 URL否
fontstring字体，iconfont 上的矢量字体否
colorstring分类颜色，iconfont 上的颜色，如：#aa33ff否
statusint状态 0-下架；1-正常否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "创建分类成功"
5}

24. 修改博客分类

  • 请求方法: POST
  • 请求 URL: /api/admin/category/update

请求参数

字段名类型描述是否必须
idint64分类ID是
namestring名称否
seqint序号，从小到大排序否
iconstring分类图标 icon 的 URL否
fontstring字体，iconfont 上的矢量字体否
colorstring分类颜色，iconfont 上的颜色，如：#aa33ff否
statusint状态 0-下架；1-正常否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "更新成功"
5}

25. 获取分类列表

  • 请求方法: POST
  • 请求 URL: /api/admin/category/getCategoryList

请求参数

字段名类型描述是否必须
statusint状态 0-下架；1-正常；-1-全部是

返回结果

1{
2    "code": 1,
3    "data": {
4        "list": [
5            {
6                "id": 1, // 分类 ID
7                "name": "Sample Category", // 名称
8                "seq": 1, // 序号，从小到大排序
9                "icon": "https://example.com/icon.png", // 分类图标 icon 的 URL
10                "font": "iconfont-class", // 字体，iconfont 上的矢量字体
11                "color": "#aa33ff", // 分类颜色，iconfont 上的颜色，如：#aa33ff
12                "createTime": "2024-08-22T15:30:00Z", // 分类创建时间
13                "updateTime": "2024-08-22T15:45:00Z", // 分类更新时间
14                "status": 1 // 状态 0-下架；1-正常
15                }
16        ]
17    },
18    "message": "更新成功"
19}

26. 创建公告

  • 请求方法: POST
  • 请求 URL: /api/admin/notice/create

请求参数

字段名类型描述是否必须
titlestring公告标题否
contentstring公告内容否
createTimetime.Time创建时间否
validTimetime.Time有效时间否
statusint公告状态（1-上架, 0-下架）否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "创建成功"
5}

27. 更新公告

  • 请求方法: POST
  • 请求 URL: /api/admin/notice/update

请求参数

字段名类型描述是否必须
idint64公告ID是
titlestring公告标题否
contentstring公告内容否
createTimetime.Time创建时间否
validTimetime.Time有效时间否
statusint公告状态（1-上架, 0-下架）否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "更新成功"
5}

28. 获取通知列表

  • 请求方法: POST
  • 请求 URL: /api/admin/notice/getNoticeList

请求参数

字段名类型描述是否必须
pageNumint分页页码是
pageSizeint分页大小是
statusint公告状态（1-上架, 0-下架, -1-全部）是

返回结果

1{
2    "code": 1,
3    "data": {
4        "count": 11212,  // 总条数
5        "list": [
6            {
7                "id": 1234567890123456789, // 公告 ID
8                "title": "Sample Notice Title", // 公告标题
9                "content": "This is the content of the notice.", // 公告内容
10                "createTime": "2024-08-22T15:30:00Z", // 创建时间
11                "updateTime": "2024-08-22T15:45:00Z", // 更新时间
12                "validTime": "2024-12-31T23:59:59Z", // 有效时间
13                "status": 1 // 公告状态（1-上架, 0-下架）
14            }
15        ]
16    },
17    "message": "获取成功"
18}

29. 获取通知详情

  • 请求方法: POST
  • 请求 URL: /api/admin/notice/getNoticeInfo

请求参数

字段名类型描述是否必须
idint64通知ID是

返回结果

1{
2    "code": 1,
3    "data": {
4        "id": 1234567890123456789, // 公告 ID
5        "title": "Sample Notice Title", // 公告标题
6        "content": "This is the content of the notice.", // 公告内容
7        "createTime": "2024-08-22T15:30:00Z", // 创建时间
8        "updateTime": "2024-08-22T15:45:00Z", // 更新时间
9        "validTime": "2024-12-31T23:59:59Z", // 有效时间
10        "status": 1 // 公告状态（1-上架, 0-下架）
11    },
12    "message": "获取成功"
13}

30. 创建专栏

  • 请求方法: POST
  • 请求 URL: /api/admin/special/create

请求参数

字段名类型描述是否必须
titlestring名称否
introstring介绍否
coverstring封面否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "创建成功"
5}

31. 更新专栏

  • 请求方法: POST
  • 请求 URL: /api/admin/special/update

请求参数

字段名类型描述是否必须
idint64专栏ID否
titlestring名称否
introstring介绍否
coverstring封面否
statusint状态：10-未发布；20-已删除；30-已发布否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "更新成功"
5}

32. 搜索专栏

  • 请求方法: POST
  • 请求 URL: /api/admin/special/searchSpecial

请求参数

字段名类型描述是否必须
pageNumint分页页码是
pageSizeint分页大小是
wordstring关键字否
statusint博客的状态值：10-已创建；20-已下架；30-已发布否

返回结果

1{
2    "code": 1,
3    "data": {
4        "count": 1231231,  // 总条数
5        "list": [
6            {
7                "id": 1, // id
8                "title": "Sample Special Title", // 标题
9                "intro": "This is a brief introduction.", // 简介
10                "cover": "https://example.com/cover.jpg", // 封面
11                "createTime": "2024-08-22T15:30:00Z", // 创建时间
12                "updateTime": "2024-08-22T15:45:00Z", // 更新时间
13                "publishTime": "2024-08-23T09:00:00Z", // 发布时间
14                "status": 30, // 状态
15                "totalCount": 23432, // 总小节数
16                "publishedCount": 112 // 已发布的小节数
17            }
18        ]
19    },
20    "message": "获取数据成功"
21}

33. 专栏添加小节

  • 请求方法: POST
  • 请求 URL: /api/admin/special/addSection

请求参数

字段名类型描述是否必须
specialIdint64专栏ID是
titlestring小节标题否
seqint排序否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "添加成功"
5}

34. 专栏更新小节

  • 请求方法: POST
  • 请求 URL: /api/admin/special/updateSection

请求参数

字段名类型描述是否必须
specialIdint64所属专栏 ID是
sectionIdint64小节 ID是
titlestring小节的标题否
introstring小节的简介，暂时用不到否
contentstringmd 编辑器产生的内容，对应的 md 内容否
htmlstringmd 编辑器产生的内容，对应的生成的 HTML否
tagsstring标签，英文逗号分隔，如："并发,线程,Java"否
isHtmlint0：md 编辑器产生的内容，1：富文本编辑器产生的内容否
readCountint64阅读数否
seqint序号，从小到大排序，默认 100否
statusint小节状态 10-已创建；20-已下架；30-已发布否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "更新成功"
5}

35. 专栏获取小节列表

  • 请求方法: POST
  • 请求 URL: /api/admin/special/getSectionList

请求参数

字段名类型描述是否必须
specialIdint64所属专栏 ID是
statusint小节状态 10-已创建；20-已下架；30-已发布否

返回结果

1{
2    "code": 1,
3    "data": {
4        "count": 12321, // 总条数
5        "list": [
6            {
7            "id": 1, // 小节 ID
8            "title": "Sample Section Title", // 小节的标题
9            "intro": "This is a brief introduction.", // 小节的简介，暂时用不到
10            "content": "This is the Markdown content.", // md 编辑器产生的内容，对应的 md 内容
11            "html": "<p>This is the generated HTML content.</p>", // md 编辑器产生的内容，对应的生成的 HTML
12            "tags": "并发,线程,Java", // 标签，英文逗号分隔，如："并发,线程,Java"
13            "isHtml": 1, // 0：md 编辑器产生的内容，1：富文本编辑器产生的内容
14            "readCount": 1234, // 阅读数
15            "specialId": 9876543210123456789, // 所属专栏 ID
16            "seq": 100, // 序号，从小到大排序，默认 100
17            "createTime": "2024-08-22T15:30:00Z", // 创建时间
18            "updateTime": "2024-08-22T15:45:00Z", // 更新时间
19            "publishTime": "2024-08-23T09:00:00Z", // 发布时间
20            "status": 30 // 小节状态
21            }
22        ]
23    },
24    "message": "获取数据成功"
25}

36. 专栏获取小节详情

  • 请求方法: POST
  • 请求 URL: /api/admin/special/getSectionDetail

请求参数

字段名类型描述是否必须
sectionIdint64小节 ID是

返回结果

1{
2    "code": 1,
3    "data": {
4        "id": 1, // 小节 ID
5        "title": "Sample Section Title", // 小节的标题
6        "intro": "This is a brief introduction.", // 小节的简介，暂时用不到
7        "content": "This is the Markdown content.", // md 编辑器产生的内容，对应的 md 内容
8        "html": "<p>This is the generated HTML content.</p>", // md 编辑器产生的内容，对应的生成的 HTML
9        "tags": "并发,线程,Java", // 标签，英文逗号分隔，如："并发,线程,Java"
10        "isHtml": 1, // 0：md 编辑器产生的内容，1：富文本编辑器产生的内容
11        "readCount": 1234, // 阅读数
12        "specialId": 9876543210123456789, // 所属专栏 ID
13        "seq": 100, // 序号，从小到大排序，默认 100
14        "createTime": "2024-08-22T15:30:00Z", // 创建时间
15        "updateTime": "2024-08-22T15:45:00Z", // 更新时间
16        "publishTime": "2024-08-23T09:00:00Z", // 发布时间
17        "status": 30 // 小节状态
18    },
19    "message": "获取小节详情成功"
20}

37. 上传图片

  • 请求方法: POST
  • 请求 URL: /api/admin/file/uploadImg

请求参数

字段名类型描述是否必须
uploadfilefile图片文件是

返回结果

1{
2    "code": 1,
3    "data": {
4        "filename": "http://xxx.png", // 图片地址
5    },
6    "message": "上传文件成功"
7}

38. 创建轮播图

  • 请求方法: POST
  • 请求 URL: /api/admin/banner/create

请求参数

字段名类型描述是否必须
titlestring名称是
urlstring图片URL是
targetUrlstring跳转 URL否
seqint序号是

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "添加成功"
5}

39. 更新轮播图

  • 请求方法: POST
  • 请求 URL: /api/admin/banner/update

请求参数

字段名类型描述是否必须
idint64轮播图ID是
titlestring名称是
urlstring图片URL是
targetUrlstring跳转 URL否
seqint序号是
statusint轮播图状态 0-已下架，1-正常否

返回结果

1{
2    "code": 1,
3    "data": null,
4    "message": "更新成功"
5}

40. 获取轮播图

  • 请求方法: GET
  • 请求 URL: /api/admin/banner/getBannerInfo

请求参数

字段名类型描述是否必须
idint64轮播图ID是

返回结果

1{
2    "code": 1,
3    "data": {
4        "id": 1, // banner id
5        "title": "Sample Banner Title", // banner 标题
6        "url": "https://example.com/banner.jpg", // 图片 url
7        "targetUrl": "https://example.com/target", // 跳转到的目标 url
8        "seq": 1, // 序号，从小到大排序
9        "createTime": "2024-08-22T15:30:00Z", // 创建时间
10        "status": 1 // banner 状态
11    },
12    "message": "获取成功"
13}

41. 获取轮播图列表

  • 请求方法: GET
  • 请求 URL: /api/admin/banner/getBannerList

请求参数

字段名类型描述是否必须
pageNumint分页页码是
pageSizeint分页大小是
statusint轮播图的状态值：0-已下架，1-正常，-1-全部是

返回结果

1{
2    "code": 1,
3    "data": {
4        "count": 123, //总条数
5        "list": [
6            {
7                "id": 1, // banner id
8                "title": "Sample Banner Title", // banner 标题
9                "url": "https://example.com/banner.jpg", // 图片 url
10                "targetUrl": "https://example.com/target", // 跳转到的目标 url
11                "seq": 1, // 序号，从小到大排序
12                "createTime": "2024-08-22T15:30:00Z", // 创建时间
13                "status": 1 // banner 状态
14            }
15        ]
16    },
17    "message": "获取成功"
18}

42. 获取轮播图列表

  • 请求方法: POST
  • 请求 URL: /api/admin/workStation/getStatistics

请求参数

字段名类型描述是否必须
pageNumint分页页码是
pageSizeint分页大小是
statusint轮播图的状态值：0-已下架，1-正常，-1-全部是

返回结果

1{
2    "code": 1,
3    "data": {
4        "blogCnt": 120, // 博客数
5        "specialCnt": 30, // 专栏数
6        "linkCnt": 50, // 友链数
7        "adminCnt": 5, // 管理员数
8        "bannerCnt": 10, // 轮播图数
9        "newBlogToday": 3, // 今日新增博客数
10        "newSpecialTodayCnt": 1 // 今日新增专栏数
11    },
12    "message": "success"
13}
点赞
收藏

评论区

加载中...

相关推荐

HttpURLConnection(http 1.1) 用法、状态码、状态描述

最近研究了java的HttpURLConnection的用法,这里简单的做一下记录:Java中可以使用HttpURLConnection来请求WEB资源。1、 URL请求的类别分为二类,GET与POST请求。二者的区别在于：     a:)get请求可以获取静态页面，也可以把参数放在URL字串后面，传递给servlet，

Java 通过get post 请求url

1️⃣.已获取小程序的access\_token为例，通过Get请求url1importcom.alibaba.fastjson.JSONObject;23StringwechatUrl"https://api.weixin.qq.com/cgibin/token?grant_typeclie

SpringBoot2 学习10 Controller接收参数的方式

地址传值@PathVariable获取路径参数。即url/{id}这种形式。?传值@RequestParam获取查询参数。即url?name这种形式用注解@RequestParam绑定请求参数到方法入参当请求参数username不存在时会有异常发生,可以通过设置属性requiredfalse解决,例如:@R

SpringBoot2 学习10 Controller接收参数的方式

地址传值@PathVariable获取路径参数。即url/{id}这种形式。?传值@RequestParam获取查询参数。即url?name这种形式用注解@RequestParam绑定请求参数到方法入参当请求参数username不存在时会有异常发生,可以通过设置属性requiredfalse解决,例如:@R

Postman 请求参数传递技巧：详解 Query、Path 和 Body 的用法

作为一个功能强大的工具，极大地简化了API测试和调试的过程，提供了发送请求和检查响应的直接方法。本文将着重介绍如何在Postman中高效地处理请求参数，以提高API测试和开发的便利性。解析请求参数首先，我们需要明白什么是请求参数。简单来说，请求参数是传递给

五、飞鹅官网API接口文档

接口列表1.获取网站信息请求方法:GET请求URL:/api/site/getSiteInfo请求参数无返回结果json"code":1,"data":"id":1,//id"title":"SampleSiteName",//网站名称"intro":"T