HelloWorld
登录

五、飞鹅官网API接口文档

飞鹅官方账号

2024-08-24

1379 1 0

接口列表

1. 获取网站信息

  • 请求方法: GET
  • 请求 URL: /api/site/getSiteInfo

请求参数

无

返回结果

1{
2    "code": 1,
3    "data": {
4        "id": 1, // id
5        "title": "Sample Site Name", // 网站名称
6        "intro": "This is a brief introduction of the site.", // 网站简介
7        "slogan": "Innovate and Inspire", // 个性签名
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 details here\"}", // 额外的信息, json字符串,具体有哪些信息，暂未定
13        "status": 1 // 网站信息状态：0-未启用；1-已启用
14        },
15    "message": "获取成功"
16}

2. 获取站长信息

  • 请求方法: GET
  • 请求 URL: /api/site/getWebmasterInfo

请求参数

无

返回结果

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

3. 获取友链列表

  • 请求方法: GET
  • 请求 URL: /api/site/getFriendLinkList

请求参数

无

返回结果

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-09-01T00:00:00Z", // 有效时间
14                "remark": "This is a sample remark.", // 备注
15                "status": 1 // 状态 0-未启用；1-已启用
16            }
17        ]
18    },
19    "message": "获取成功"
20}

4. 获取通知列表

  • 请求方法: GET
  • 请求 URL: /api/site/getNoticeList

请求参数

无

返回结果

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

5. 获取轮播图列表

  • 请求方法: GET
  • 请求 URL: /api/site/getBannerList

请求参数

无

返回结果

1{
2    "code": 1,
3    "data": {
4        "count": 1122,  // 总条数
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 状态 1-上架 0-下架
14            }
15        ]
16    },
17    "message": "获取成功"
18}

6. 获取博客分类列表

  • 请求方法: POST
  • 请求 URL: /api/blog/getCateList

请求参数

无

返回结果

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

7. 获取分类下的博客列表

  • 请求方法: POST
  • 请求 URL: /api/blog/getCateBlogList

请求参数（JSON）

1{
2  "cateId": 1, // 分类 id  必填
3  "pageNum": 1, // 第几页，从1开始  必填
4  "pageSize": 20 // 每页的数量  必填
5}

返回结果

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

8. 根据action获取博客列表

  • 请求方法: POST
  • 请求 URL: /api/blog/getBlogListByAction

请求参数（JSON）

1{
2  "action": 1, // 0：获取最新博客，1：获取最热博客 必填
3  "pageNum": 1, // 第几页，从1开始  必填
4  "pageSize": 20 // 每页的数量  必填
5}

返回结果

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

9. 获取所有的标签

  • 请求方法: POST
  • 请求 URL: /api/blog/getAllTags

请求参数

无

返回结果

1{
2    "code": 1,
3    "data": ["tag1", "tag2"],
4    "message": "获取成功"
5}

10. 根据标签获取博客

  • 请求方法: POST
  • 请求 URL: /api/blog/getBlogListByTag

请求参数（JSON）

1{
2  "name": 1, // 标签名字 必填
3  "pageNum": 1, // 第几页，从1开始  必填
4  "pageSize": 20 // 每页的数量  必填
5}

返回结果

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

11. 搜索博客（只搜索标题）

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

请求参数（JSON）

1{
2  "word": "keyword", // 关键词 非必填
3  "status": 1, // 博客状态 10-已创建；20-已下架；30-已发布 非必填
4  "pageNum": 1, // 第几页，从1开始  必填
5  "pageSize": 20 // 每页的数量  必填
6}

返回结果

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

12. 获取博客详情

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

请求参数（JSON）

1{
2  "id": 1, // 博客id 必填
3}

返回结果

1{
2    "code": 1,
3    "data": {
4        "blog": {
5            "id": 1, // 博客 id
6            "title": "Sample Blog Title", // 博客的标题
7            "intro": "This is a brief introduction to the blog.", // 博客的简介
8            "content": "Markdown content here...", // md 编辑器产生的内容时，对应的 md 的内容
9            "html": "<p>HTML content here...</p>", // md 编辑器产生的内容时，对应的生成的 html
10            "isHtml": 0, // 0：md 编辑器产生的内容，1：富文本编辑器产生的内容
11            "isTop": 1, // 是否置顶, 0: 不置顶，1：置顶
12            "readCount": 123, // 阅读数
13            "createTime": "2024-08-22T15:30:00Z", // 创建时间
14            "updateTime": "2024-08-22T15:45:00Z", // 更新时间
15            "publishTime": "2024-08-23T00:00:00Z", // 发布时间
16            "thumbnail": "https://example.com/thumbnail.jpg", // 缩略图, 是一个 url
17            "status": 10, // 博客状态 10-已创建；20-已下架；30-已发布
18            "cateId": 9876543210987654321, // 博客分类 id
19            "tags": "concurrency,threads,Java" // 标签，英文逗号分隔，如："并发,线程,Java"
20        },
21        "list": [
22            {
23                "id": 1, // 博客 id
24                "title": "Sample Blog Title", // 博客的标题
25                "intro": "This is a brief introduction to the blog.", // 博客的简介
26                "content": "Markdown content here...", // md 编辑器产生的内容时，对应的 md 的内容
27                "html": "<p>HTML content here...</p>", // md 编辑器产生的内容时，对应的生成的 html
28                "isHtml": 0, // 0：md 编辑器产生的内容，1：富文本编辑器产生的内容
29                "isTop": 1, // 是否置顶, 0: 不置顶，1：置顶
30                "readCount": 123, // 阅读数
31                "createTime": "2024-08-22T15:30:00Z", // 创建时间
32                "updateTime": "2024-08-22T15:45:00Z", // 更新时间
33                "publishTime": "2024-08-23T00:00:00Z", // 发布时间
34                "thumbnail": "https://example.com/thumbnail.jpg", // 缩略图, 是一个 url
35                "status": 10, // 博客状态 10-已创建；20-已下架；30-已发布
36                "cateId": 9876543210987654321, // 博客分类 id
37                "tags": "concurrency,threads,Java" // 标签，英文逗号分隔，如："并发,线程,Java"
38            }
39        ]
40    },
41    "message": "获取博客成功"
42}

13. 获取专栏列表

  • 请求方法: POST
  • 请求 URL: /api/special/getSpecialList

请求参数（JSON）

1{
2  "pageNum": 1, // 第几页，从1开始  必填
3  "pageSize": 20 // 每页的数量  必填
4}

返回结果

1{
2    "code": 1,
3    "data": {
4        "hasMore": true,  // 还有更多
5        "list": [
6            {
7                "id": 1, // id
8                "title": "Special Feature Title", // 标题
9                "intro": "This is a brief introduction to the special feature.", // 简介
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-23T00:00:00Z", // 发布时间
14                "status": 20, // 状态 10-已创建；20-已下架；30-已发布
15                "publishedCount": 2, // 已发布的小节数
16                "readCount": 3, // 章节的阅读数
17            }
18
19        ]
20    },
21    "message": "获取成功"
22}

14. 获取专栏的详情

  • 请求方法: POST
  • 请求 URL: /api/special/getSpecialDetail

请求参数（JSON）

1{
2  "specialId": 1, // 专栏ID  必填
3}

返回结果

1{
2    "code": 1,
3    "data": {
4        "special": {  // 专栏数据
5            "id": 1, // id
6                "title": "Special Feature Title", // 标题
7                "intro": "This is a brief introduction to the special feature.", // 简介
8                "cover": "https://example.com/cover.jpg", // 封面
9                "createTime": "2024-08-22T15:30:00Z", // 创建时间
10                "updateTime": "2024-08-22T15:45:00Z", // 更新时间
11                "publishTime": "2024-08-23T00:00:00Z", // 发布时间
12                "status": 20, // 状态 10-已创建；20-已下架；30-已发布
13        },
14        "list": [  // 专栏小节
15            {
16                "id": 1, // 小节 id
17                "title": "Section Title", // 小节的标题
18                "intro": "This is an introduction to the section.", // 小节的简介，暂时用不到
19                "content": "Markdown content here...", // md 编辑器产生的内容时，对应的 md 的内容
20                "html": "<p>HTML content here...</p>", // md 编辑器产生的内容时，对应的生成的 html
21                "tags": "concurrency,threads,Java", // 标签，英文逗号分隔，如："并发,线程,Java"
22                "isHtml": 0, // 0：md 编辑器产生的内容，1：富文本编辑器产生的内容
23                "readCount": 12345, // 阅读数
24                "specialId": 9876543210987654321, // 所属专栏 id
25                "seq": 100, // 序号，从小到大排序，默认100
26                "createTime": "2024-08-22T15:30:00Z", // 创建时间
27                "updateTime": "2024-08-22T15:45:00Z", // 更新时间
28                "publishTime": "2024-08-23T00:00:00Z", // 发布时间
29                "status": 30, // 小节状态 10-已创建；20-已下架；30-已发布
30            }
31        ]
32    },
33    "message": "获取成功"
34}

15. 获取小节的详情

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

请求参数（JSON）

1{
2  "sectionId": 1, // 小节ID  必填
3}

返回结果

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

评论区

加载中...

相关推荐

MySQL部分从库上面因为大量的临时表tmp_table造成慢查询

背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_

收藏这些API，获取网易云音乐数据超轻松

汇总了常见的网易云音乐API，墙裂建议点击右上角收藏下面是常见的网易云音乐get请求的API。简单介绍一下它们：评论http://music.163.com/api/v1/resource/comments/RSO4歌曲ID?limit20&offset0这应该是最最最常见的了，毕竟80%的网易云音乐的爬虫/数据分析文章都是关于评论数据使用技

java将前端的json数组字符串转换为列表

记录下在前端通过ajax提交了一个json数组的字符串，在后端如何转换为列表。前端数据转化与请求varcontracts{id:'1',name:'yanggb合同1'},{id:'2',name:'yanggb合同2'},{id:'3',name:'yang

2020年前端实用代码段，为你的工作保驾护航

有空的时候，自己总结了几个代码段，在开发中也经常使用，谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )

收藏这些API，获取网易云音乐数据超轻松

汇总了常见的网易云音乐API，墙裂建议点击右上角收藏下面是常见的网易云音乐get请求的API。简单介绍一下它们：评论http://music.163.com/api/v1/resource/comments/R_SO_4_{歌曲ID}?limit20&offset0这应该是最最最常见的了，毕竟80%

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

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