Token

1 Client_Credentials授权

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/token

Body参数名 类型 必需 描述 示例 e.g.
client_id string 客户端ID client_id
client_secret string 客户端密钥 client_secret
grant_type string 授权类型 client_credentials

详细说明:

client_credentials授权方式获取token

返回示例:

                            {
    "access_token": "this token string",
    "expires_in": 86400,
    "token_type": "Bearer"
}
                            
Body参数名 描述 类型
access_token 访问令牌 string
expires_in 过期时间 number
token_type 令牌类型 string

2.1 获取授权码

在线测试 在线浏览

请求方式:GET

请求地址:https://oauth.cnblogs.com/connect/authorize

Body参数名 类型 必需 描述 示例 e.g.
client_id string 申请的client_id your client_id
scope string 默认 openid profile CnBlogsApi
response_type string 默认 code id_token
redirect_uri string 默认回调地址(可以联系管理员修改) https://oauth.cnblogs.com/auth/callback
state string 可以指定任意值(必填) cnblogs.com
nonce string 随机字符串(自己创建) cnblogs.com

详细说明:

1.在浏览器中请求该地址,会引导用户到博客园的登录页面。
2.登录成功后,重定向到https://oauth.cnblogs.com/auth/callback(默认回调页面)并带上code参数。
3.截取Url中的code换取token,详情请见(2.2 Authorization_code授权)

2.2 Authorization_Code授权

在线测试 在线浏览

请求方式:POST

请求地址:https://oauth.cnblogs.com/connect/token

Header参数名 类型 必需 描述 示例 e.g.
Content-Type string application/x-www-form-urlencoded
Body参数名 类型 必需 描述 示例 e.g.
client_id string 授权ID client_id
client_secret string 密钥 client_secret
grant_type string 授权模式 authorization_code
code string 授权码 code
redirect_uri string 回调地址(默认) https://oauth.cnblos.com/auth/callback

详细说明:

code参数值需要用户登陆才能获取到,请看获取授权码文档

返回示例:

                            {
    "access_token": "this is token string",
    "expires_in": 586400,
    "token_type": "Bearer",
    "refresh_token": "this is refresh token string"
}
                            
Body参数名 描述 类型
access_token 访问令牌 string
expires_in 过期时间 number
token_type 令牌类型 string
refresh_token 更新令牌 string

Users

获取当前登录用户信息

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/users

Header参数名 类型 必需 描述 示例 e.g.
Authorization string Bearer your access_token

详细说明:

获取当前登录用户信息

返回示例:

                            {
  "UserId": "4566ea6b-f2b3",
  "SpaceUserId": 2,
  "BlogId": 3,
  "DisplayName": "sample string 4",
  "Face": "sample string 5",
  "Avatar": "sample string 6",
  "Seniority": "sample string 7",
  "BlogApp": "sample string 8"
}
                            
Body参数名 描述 类型
UserId 用户id string
SpaceUserId 用户显示名称id number
BlogId 博客id number
DisplayName 显示名称 string
Face 头像url string
Avatar 头像url string
Seniority 园龄 string
BlogApp 博客名 string

Blogs

获取个人博客信息

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/blogs/{blogApp}

Body参数名 类型 必需 描述 示例 e.g.
blogApp string 博客名 hellocnblogs

详细说明:

获取个人博客信息

返回示例:

                            {
    "blogId": 40823,
    "title": "it新闻",
    "subtitle": "提供最新IT资讯",
    "postCount": 33,
    "pageSize": 10,
    "enableScript": false
}
                            
Body参数名 描述 类型
blogId 博客id number
title 标题 string
subtitle 子标题 string
postCount 博客数量 number
pageSize 页容量 number
enableScript 是否加密 boolean

Bookmarks

根据URL检查收藏是否已存在

在线测试 在线浏览

请求方式:HEAD

请求地址:https://api.cnblogs.com/api/Bookmarks?url={url}

Body参数名 类型 必需 描述 示例 e.g.
url string 收藏链接 www.cnblogs.com

详细说明:

根据URL检查收藏是否已存在

根据url删除收藏,url需要编码

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/Bookmarks?url={url}

Body参数名 类型 必需 描述 示例 e.g.
url string 收藏编号 www.cnblogs.com

详细说明:

根据url删除收藏,url需要编码

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

修改收藏

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/bookmarks/{id}

Body
Body参数名 类型 必需 描述 示例 e.g.
id string 收藏编号

详细说明:

修改收藏

添加收藏

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/Bookmarks

Body

详细说明:

添加收藏

分页获取收藏列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/Bookmarks?pageIndex={pageIndex}&pageSize={pageSize}

Body参数名 类型 必需 描述 示例 e.g.
pageIndex number 页码 1
pageSize number 页容量 10

详细说明:

分页获取收藏列表

返回示例:

                            [
  {
    "WzLinkId": 1,
    "Title": "sample string 2",
    "LinkUrl": "sample string 3",
    "Summary": "sample string 4",
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "DateAdded": "2017-06-25T19:42:03.8765962+08:00",
    "FromCNBlogs": true
  },
  {
    "WzLinkId": 1,
    "Title": "sample string 2",
    "LinkUrl": "sample string 3",
    "Summary": "sample string 4",
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "DateAdded": "2017-06-25T19:42:03.8765962+08:00",
    "FromCNBlogs": true
  }
]
                            
Body参数名 描述 类型
WzLinkId 收藏编号 string
Title 标题 string
LinkUrl 收藏链接 string
Summary 收藏标题 string
Tags 标签 string
DateAdded 添加时间 string
FromCNBlogs 是否来自博客园 string

根据id删除收藏

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/bookmarks/{id}

Body参数名 类型 必需 描述 示例 e.g.
id number 收藏编号 112233

详细说明:

根据id删除收藏

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

获取网摘数量(Response.Headers("X-Count"))

在线测试 在线浏览

请求方式:HEAD

请求地址:https://api.cnblogs.com/api/Bookmarks

详细说明:

获取网摘数量(Response.Headers("X-Count"))

BlogPosts

获取个人博客随笔列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/blogs/{blogApp}/posts?pageIndex={pageIndex}

Body参数名 类型 必需 描述 示例 e.g.
blogApp string 博客名 cnblogs
pageIndex number 页码 1

详细说明:

获取个人博客随笔列表

返回示例:

                            [
  {
    "Id": 1,
    "Title": "sample string 2",
    "Url": "sample string 3",
    "Description": "sample string 4",
    "Author": "sample string 5",
    "BlogApp": "sample string 6",
    "Avatar": "sample string 7",
    "PostDate": "2017-06-25T20:15:30.2514989+08:00",
    "ViewCount": 9,
    "CommentCount": 10,
    "DiggCount": 11
  },
  {
    "Id": 1,
    "Title": "sample string 2",
    "Url": "sample string 3",
    "Description": "sample string 4",
    "Author": "sample string 5",
    "BlogApp": "sample string 6",
    "Avatar": "sample string 7",
    "PostDate": "2017-06-25T20:15:30.2514989+08:00",
    "ViewCount": 9,
    "CommentCount": 10,
    "DiggCount": 11
  }
]
                            
Body参数名 描述 类型
Id 编号 number
Title 标题 string
Url 博文链接 string
Description 摘要 string
Author 作者 string
BlogApp 博客名 string
Avatar 头像 string
PostDate 发布时间 string
ViewCount 浏览次数 number
CommentCount 评论次数 number
DiggCount 点击次数 number

获取博文内容

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/blogposts/{id}/body

Body参数名 类型 必需 描述 示例 e.g.
id number 博文编号 1111

详细说明:

获取博文内容

返回示例:

                            "sample string 1"
                            

分页获取精华区博文列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/blogposts/@picked?pageIndex={pageIndex}&pageSize={pageSize}

Body参数名 类型 必需 描述 示例 e.g.
pageIndex string 页码 1
pageSize string 页容量 10

详细说明:

分页获取精华区博文列表

返回示例:

                            [
  {
    "Id": 1,
    "Title": "sample string 2",
    "Url": "sample string 3",
    "Description": "sample string 4",
    "Author": "sample string 5",
    "BlogApp": "sample string 6",
    "Avatar": "sample string 7",
    "PostDate": "2017-06-25T20:13:38.892135+08:00",
    "ViewCount": 9,
    "CommentCount": 10,
    "DiggCount": 11
  },
  {
    "Id": 1,
    "Title": "sample string 2",
    "Url": "sample string 3",
    "Description": "sample string 4",
    "Author": "sample string 5",
    "BlogApp": "sample string 6",
    "Avatar": "sample string 7",
    "PostDate": "2017-06-25T20:13:38.892135+08:00",
    "ViewCount": 9,
    "CommentCount": 10,
    "DiggCount": 11
  }
]
                            
Body参数名 描述 类型
Id 编号 number
Title 标题 string
Url 博文链接 string
Description 简介 string
Author 作者 string
BlogApp 博客名 string
Avatar 头像 date
PostDate 发布时间 string
ViewCount 浏览次数 number
CommentCount 评论次数 number
DiggCount 点击次数 number

分页获取网站首页博文列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/blogposts/@sitehome?pageIndex={pageIndex}&pageSize={pageSize}

Body参数名 类型 必需 描述 示例 e.g.
pageIndex string 页码 1
pageSize string 页容量 10

详细说明:

分页获取网站首页博文列表

返回示例:

                            [
  {
    "Id": 1,
    "Title": "sample string 2",
    "Url": "sample string 3",
    "Description": "sample string 4",
    "Author": "sample string 5",
    "BlogApp": "sample string 6",
    "Avatar": "sample string 7",
    "PostDate": "2017-06-25T20:11:47.0952592+08:00",
    "ViewCount": 9,
    "CommentCount": 10,
    "DiggCount": 11
  },
  {
    "Id": 1,
    "Title": "sample string 2",
    "Url": "sample string 3",
    "Description": "sample string 4",
    "Author": "sample string 5",
    "BlogApp": "sample string 6",
    "Avatar": "sample string 7",
    "PostDate": "2017-06-25T20:11:47.0952592+08:00",
    "ViewCount": 9,
    "CommentCount": 10,
    "DiggCount": 11
  }
]
                            
Body参数名 描述 类型
Id 编号 number
Title 标题 string
Url 链接 string
Description 说明 string
Author 作者 string
BlogApp 博客名 string
Avatar 头像链接 string
PostDate 发布时间 string
ViewCount 浏览次数 number
CommentCount 评论次数 number
DiggCount 点击次数 number

BlogPostComments

添加博文评论

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/blogs/{blogApp}/posts/{postId}/comments

Body
Body参数名 类型 必需 描述 示例 e.g.
blogApp string 博客名
postId string 博客编号

详细说明:

添加博文评论

获取博文的评论列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/blogs/{blogApp}/posts/{postId}/comments?pageIndex={pageIndex}&pageSize={pageSize}

Body参数名 类型 必需 描述 示例 e.g.
blogApp string 博客名 cnblogs
postId number 博文编号 112233
pageIndex number 页码 1
pageSize number 页容量 10

详细说明:

获取博文的评论列表

返回示例:

                            [
  {
    "Id": 1,
    "Body": "sample string 2",
    "Author": "sample string 3",
    "AuthorUrl": "sample string 4",
    "FaceUrl": "sample string 5",
    "Floor": 6,
    "DateAdded": "2017-06-25T19:59:07.8609221+08:00"
  },
  {
    "Id": 1,
    "Body": "sample string 2",
    "Author": "sample string 3",
    "AuthorUrl": "sample string 4",
    "FaceUrl": "sample string 5",
    "Floor": 6,
    "DateAdded": "2017-06-25T19:59:07.8609221+08:00"
  }
]
                            
Body参数名 描述 类型
Id 编号 number
Body 内容 string
Author 作者 string
AuthorUrl 作者链接 string
FaceUrl 头像链接 string
Floor string
DateAdded 添加时间 string

KbArticles

分页获取知识库文章列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/KbArticles?pageIndex={pageIndex}&pageSize={pageSize}

Body参数名 类型 必需 描述 示例 e.g.
pageIndex string 页码
pageSize string 页容量

详细说明:

分页获取知识库文章列表

返回示例:

                            [
  {
    "Id": 1,
    "Title": "sample string 2",
    "Summary": "sample string 3",
    "Author": "sample string 4",
    "ViewCount": 5,
    "DiggCount": 6,
    "DateAdded": "2017-06-25T19:56:33.5328019+08:00"
  },
  {
    "Id": 1,
    "Title": "sample string 2",
    "Summary": "sample string 3",
    "Author": "sample string 4",
    "ViewCount": 5,
    "DiggCount": 6,
    "DateAdded": "2017-06-25T19:56:33.5328019+08:00"
  }
]
                            
Body参数名 描述 类型
Id 编号 string
Title 标题 string
Summary 标题 string
Author 作者 string
ViewCount 查看次数 string
DiggCount 点击次数 string
DateAdded 添加时间 string

获取文章内容

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/kbarticles/{id}/body

Body参数名 类型 必需 描述 示例 e.g.
id string

详细说明:

获取文章内容

返回示例:

                            "sample string 1"
                            

NewsItems

分页获取新闻列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/NewsItems?pageIndex={pageIndex}&pageSize={pageSize}

Body参数名 类型 必需 描述 示例 e.g.
pageIndex string 页码 1
pageSize string 页容量 10

详细说明:

分页获取新闻列表

返回示例:

                            [
  {
    "Id": 1,
    "Title": "sample string 2",
    "Summary": "sample string 3",
    "TopicId": 4,
    "TopicIcon": "sample string 5",
    "ViewCount": 6,
    "CommentCount": 7,
    "DiggCount": 8,
    "DateAdded": "2017-06-25T06:31:05.9725356+08:00"
  },
  {
    "Id": 1,
    "Title": "sample string 2",
    "Summary": "sample string 3",
    "TopicId": 4,
    "TopicIcon": "sample string 5",
    "ViewCount": 6,
    "CommentCount": 7,
    "DiggCount": 8,
    "DateAdded": "2017-06-25T06:31:05.9725356+08:00"
  }
]
                            
Body参数名 描述 类型
Id 编号 number
Title 标题 string
Summary 标题 string
TopicId string
TopicIcon string
ViewCount 浏览次数 number
CommentCount 评论次数 number
DiggCount 点击次数 number
DateAdded 添加时间 string

获取新闻内容

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/newsitems/{id}/body

Body参数名 类型 必需 描述 示例 e.g.
id string 新闻编号

详细说明:

获取新闻内容

返回示例:

                            "sample string 1"
                            

分页获取热门新闻

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/newsitems/@hot?startDate={startDate}&endDate={endDate}&pageIndex={pageIndex}&pageSize={pageSize}

Body参数名 类型 必需 描述 示例 e.g.
startDate string 开始时间
endDate string 结束时间
pageIndex string 页码
pageSize string 页容量

详细说明:

分页获取热门新闻

返回示例:

                            [
  {
    "Id": 1,
    "Title": "sample string 2",
    "Summary": "sample string 3",
    "TopicId": 4,
    "TopicIcon": "sample string 5",
    "ViewCount": 6,
    "CommentCount": 7,
    "DiggCount": 8,
    "DateAdded": "2017-06-25T20:04:48.7202819+08:00"
  },
  {
    "Id": 1,
    "Title": "sample string 2",
    "Summary": "sample string 3",
    "TopicId": 4,
    "TopicIcon": "sample string 5",
    "ViewCount": 6,
    "CommentCount": 7,
    "DiggCount": 8,
    "DateAdded": "2017-06-25T20:04:48.7202819+08:00"
  }
]
                            
Body参数名 描述 类型
Id 编号 number
Title 标题 string
Summary 标题 string
TopicId string
TopicIcon string
ViewCount 浏览次数 number
CommentCount 评论次数 number
DiggCount 点击次数 number
DateAdded 添加时间 string

分页获取本周内热门新闻

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/newsitems/@hot-week?pageIndex={pageIndex}&pageSize={pageSize}

Body参数名 类型 必需 描述 示例 e.g.
pageIndex number 页码 1
pageSize number 页容量 10

详细说明:

分页获取本周内热门新闻

返回示例:

                            [
  {
    "Id": 1,
    "Title": "sample string 2",
    "Summary": "sample string 3",
    "TopicId": 4,
    "TopicIcon": "sample string 5",
    "ViewCount": 6,
    "CommentCount": 7,
    "DiggCount": 8,
    "DateAdded": "2017-06-25T20:06:56.0952729+08:00"
  },
  {
    "Id": 1,
    "Title": "sample string 2",
    "Summary": "sample string 3",
    "TopicId": 4,
    "TopicIcon": "sample string 5",
    "ViewCount": 6,
    "CommentCount": 7,
    "DiggCount": 8,
    "DateAdded": "2017-06-25T20:06:56.0952729+08:00"
  }
]
                            
Body参数名 描述 类型
Id 编号 number
Title 标题 string
Summary 标题 string
TopicId string
TopicIcon string
ViewCount 浏览次数 number
CommentCount 评论次数 number
DiggCount 点击次数 number
DateAdded 添加时间 string

分页获取推荐新闻

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/newsitems/@recommended?pageIndex={pageIndex}&pageSize={pageSize}

Body参数名 类型 必需 描述 示例 e.g.
pageIndex number 页码 1
pageSize number 页容量 10

详细说明:

分页获取推荐新闻

返回示例:

                            [
  {
    "Id": 1,
    "Title": "sample string 2",
    "Summary": "sample string 3",
    "TopicId": 4,
    "TopicIcon": "sample string 5",
    "ViewCount": 6,
    "CommentCount": 7,
    "DiggCount": 8,
    "DateAdded": "2017-06-25T20:03:09.204658+08:00"
  },
  {
    "Id": 1,
    "Title": "sample string 2",
    "Summary": "sample string 3",
    "TopicId": 4,
    "TopicIcon": "sample string 5",
    "ViewCount": 6,
    "CommentCount": 7,
    "DiggCount": 8,
    "DateAdded": "2017-06-25T20:03:09.204658+08:00"
  }
]
                            
Body参数名 描述 类型
Id 编号 number
Title 标题 string
Summary 标题 string
TopicId string
TopicIcon string
ViewCount 浏览次数 number
CommentCount 评论次数 number
DiggCount 点击次数 number
DateAdded 添加时间 string

NewsComments

修改新闻评论

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/newscomments/{id}

Body
Body参数名 类型 必需 描述 示例 e.g.
id string 评论编号

详细说明:

修改新闻评论

返回示例:

                            "sample string 1"
                            
Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

发布新闻评论

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/news/{newsId}/comments

Body
Body参数名 类型 必需 描述 示例 e.g.
newsId number 新闻编号 528994

详细说明:

发布新闻评论

根据新闻Id分页获取新闻评论

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/news/{newsId}/[ { "commentID": 287365, "contentID": 528922, "commentContent": "单纯想象一下就觉得很疯狂啊。", "userGuid": "e14bccfd-3ed8-df11-ac81-842b2b196315", "userId": 168112, "userName": "Firen", "faceUrl": "https://pic.cnblogs.com/face/168112/20151104135814.png", "floor": 1, "dateAdded": "2015-09-11T17:02:49.653", "agreeCount": 0, "antiCount": 0, "parentCommentID": 0, "parentComment": null }, { "commentID": 287370, "contentID": 528922, "commentContent": "霍金可以试一下", "userGuid": "68a4f62b-cdfd-df11-ac81-842b2b196315", "userId": 224049, "userName": "

Body参数名 类型 必需 描述 示例 e.g.
newsId string 新闻id
pageIndex number 页码
pageSize number 页容量

详细说明:

根据新闻Id分页获取新闻列表

返回示例:

                            [
    {
        "commentID": 287365,
        "contentID": 528922,
        "commentContent": "单纯想象一下就觉得很疯狂啊。",
        "userGuid": "e14bccfd-3ed8-df11-ac81-842b2b196315",
        "userId": 168112,
        "userName": "Firen",
        "faceUrl": "https://pic.cnblogs.com/face/168112/20151104135814.png",
        "floor": 1,
        "dateAdded": "2015-09-11T17:02:49.653",
        "agreeCount": 0,
        "antiCount": 0,
        "parentCommentID": 0,
        "parentComment": null
    }
]
                            
Body参数名 描述 类型
commentID 评论编号 number
contentID 内容编号 number
commentContent 评论内容 string
userGuid 用户编号 string
userId 用户编号 number
userName 用户名 string
faceUrl 头像地址 string
floor number
dateAdded 添加时间 string
agreeCount 赞同人数 number
antiCount 反对人数 number
parentCommentID number
parentComment string

删除新闻评论

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/newscomments/{id}

Body参数名 类型 必需 描述 示例 e.g.
id string 评论编号

详细说明:

删除新闻评论

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

Statuses

获取最新一条闪存内容

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/statuses/recent

详细说明:

获取最新一条闪存内容

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

发布闪存评论

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/statuses/{statusId}/comments

Body
Body参数名 类型 必需 描述 示例 e.g.
statusId string 闪存编号
ReplyTo string
ParentCommentId string
Content string 内容

详细说明:

发布闪存评论

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

删除闪存

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/statuses/{id}

Body参数名 类型 必需 描述 示例 e.g.
id string 闪存编号

详细说明:

删除闪存


Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

获取闪存评论

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/statuses/{statusId}/comments

Body参数名 类型 必需 描述 示例 e.g.
statusId string 闪存编号

详细说明:

获取闪存评论

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

发布闪存

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/statuses

Body
Body参数名 类型 必需 描述 示例 e.g.
Content string 内容
IsPrivate string 是否私有

详细说明:

发布闪存

返回示例:

                    {
  "Content": "sample string 1",
  "IsPrivate": true
}
                            
Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

删除闪存评论

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/statuses/{statusId}/comments/{id}

Body参数名 类型 必需 描述 示例 e.g.
statusId string
id string

详细说明:

删除闪存评论

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

根据类型获取闪存列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/statuses/@{type}?pageIndex={pageIndex}&pageSize={pageSize}&tag={tag}

Body参数名 类型 必需 描述 示例 e.g.
type string 类型
pageIndex string 页码
pageSize string 页容量
tag string 标签

详细说明:

根据类型获取闪存列表

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

根据Id获取闪存

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/statuses/{id}

Body参数名 类型 必需 描述 示例 e.g.
id string 闪存编号

详细说明:

根据类型获取闪存列表

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

Question

提问

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/questions

Body
Body参数名 类型 必需 描述 示例 e.g.
Title string 问题标题
Content string 问题内容
Tags string 问题标签
Flags number 发布标志 1 表示发布至首页,2表示不发布至首页
UserID string 用户ID

详细说明:

提问

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

评论

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/questions/{questionId}/answers/{answerId}/comments?loginName={XXX}

Body
Body参数名 类型 必需 描述 示例 e.g.
questionId number 问题id
answerId number 回答id
Content string 评论内容
ParentCommentId number 父评论ID
PostUserID number 提交者用户ID
loginName string 提交者用户名

详细说明:

发布评论

返回示例:

                    {
  "Content": "sample string 1",
  "ParentCommentId": 2
}
                            
Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

获取单个回答的评论列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/questions/answers/{answerId}/comments

Body参数名 类型 必需 描述 示例 e.g.
answerId string 回答ID

详细说明:

根据回答ID,返回该回答的评论列表。

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

判断用户是否回答过某个问题

在线测试 在线浏览

请求方式:HEAD

请求地址:https://api.cnblogs.com/api/questions/{questionId}?userId={userId}

Body参数名 类型 必需 描述 示例 e.g.
questionId string 问题ID
userId string 用户ID

详细说明:

根据 “用户的ID” 以及 “问题ID” 判断用户是否回答过某个问题。

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

删除回答

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/questions/{questionId}/answers/{answerId}

Body参数名 类型 必需 描述 示例 e.g.
questionId string
answerId string

详细说明:

根据问题ID 以及回答ID 来删除回答,只能删除自己的回答。

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

修改回答

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/questions/{questionId}/answers/{answerId}

Body
Body参数名 类型 必需 描述 示例 e.g.
questionId string 问题ID
answerId string 回答ID
Answer string 回答内容
UserID string 用户ID

详细说明:

修改回答

返回示例:

                    {
  "Answer": "sample string 1"
}
                            
Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

根据类型获取问题列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/questions/@{type}?pageIndex={pageIndex}&pageSize={pageSize}

Body参数名 类型 必需 描述 示例 e.g.
type string 列表类型 高分问题,已解决,新回答等
pageIndex number 页码 默认为 1
pageSize number 页面容量 默认为 25
spaceUserId number 用户ID 默认为 0

详细说明:

根据列表类型,获取相对应的问题列表,主要有下面几种类型:
  • 问题首页列表:                                type = "unsolved"
  • 高分问题列表:                                type = "highscore"
  • 零回答问题列表:                             type = "noanswer"
  • 已解决问题列表:                             type = "solved"
  • 某个用户提问的问题列表:               type = "myquestion" 
  • 某个用户未解决的问题列表:            type = "myunsolved" 
  • 某个用户回答的问题列表:               type = "myanswer" 
  • 某个用户回答被采纳的问题列表:     type = "mybestanswer" 


Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

获取单个问题对应的回答列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/questions/{questionId}/answers

Body参数名 类型 必需 描述 示例 e.g.
questionId string 问题ID

详细说明:

根据问题ID返回该问题的回答列表。

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

修改问题

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/questions/{questionId}

Body
Body参数名 类型 必需 描述 示例 e.g.
questionId string 问题ID
Title string 问题标题
Content string 问题内容
Tags string 问题标签
Flags string 问题标志 1 表示发布至首页,2表示不发布至首页
UserID number 用户ID

详细说明:

修改问题

返回示例:

                    {
  "Title": "sample string 1",
  "Content": "sample string 2",
  "Tags": "sample string 3",
  "Flags": 4
}
                            
Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

删除评论

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/questions/{questionId}/answers/{answerId}/comments/{commentId}

Body参数名 类型 必需 描述 示例 e.g.
questionId string 问题id
answerId string 回答id
commentId string 评论id

详细说明:

根据问题ID,回答ID, 以及评论ID 来删除评论,只能删除自己的评论。

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

回答

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/questions/{questionId}/answers?loginName={"XXX"}

Body
Body参数名 类型 必需 描述 示例 e.g.
questionId number 回答的问题ID
loginName string 用户名
Answer string 回答内容
UserID number
UserName string

详细说明:

发布回答

返回示例:

                    {
  "Answer": "sample string 1"
}
                            
Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

更新评论

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/questions/{questionId}/answers/{answerId}/comments/{commentId}

Body
Body参数名 类型 必需 描述 示例 e.g.
questionId number 问题id
answerId number 问题id
commentId number 评论Id
Content string
PostUserID number 提交者ID

详细说明:

更新评论

返回示例:

                    {
  "Content": "sample string 1",
  "ParentCommentId": 2
}
                            
Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

获取首页问题列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/questions/@sitehome?pageIndex={pageIndex}&pageSize={pageSize}

Body参数名 类型 必需 描述 示例 e.g.
pageIndex number 页码 默认为 1
pageSize number 页面容量 默认为 25

详细说明:

获取博问首页问题列表

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

删除问题

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/questions/{questionId}

Body参数名 类型 必需 描述 示例 e.g.
questionId string 问题Id

详细说明:

根据问题ID 来删除问题,只能删除用户自己提的问题,无法删除已结贴的问题。

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

获取单个问题的详情

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/questions/{questionId}

Body参数名 类型 必需 描述 示例 e.g.
questionId number 问题ID

详细说明:

根据输入的'questionId' ,返回该问题的详细信息。

Body参数名 描述 类型
Version string
Content string
StatusCode string
ReasonPhrase string
Headers string
RequestMessage string
IsSuccessStatusCode string

Edu

根据Id获取班级信息

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/schoolclass/{schoolClassId}

Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 班级Id 1

返回示例:

                    {
    "schoolClassId": 1,
    "icon": "http://images2015.cnblogs.com/blog/1/201604/1-20160430154644191-2093926076.png",
    "url": "/campus/ruc/software-engineering-13",
    "nameCn": "软件工程13级",
    "nameEn": "software-engineering-13",
    "postCount": 22,
    "memberCount": 0,
    "bulletinCount": 0,
    "universityId": 1,
    "creatorBlogId": 0,
    "lastPostTime": "2016-04-11T22:48:00",
    "universityNameCn": "中国人民大学",
    "universityNameEn": "ruc",
    "courseEnd": null,
    "dateAdded": "2017-06-29T19:27:24.2872093",
    "isActive": false
}
                            
Body参数名 描述 类型
schoolClassId 班级Id number
icon 班级图标 string
url 班级链接 string
nameCn 班级中文名 string
nameEn 班级英文名 string
postCount 博文数 number
memberCount 成员数 number
bulletinCount 公告数 number
universityId 校区Id number
creatorBlogId 创建者博客Id number
lastPostTime 最后发表博文时间 datetime
universityNameCn 校区中文名 string
universityNameEn 校区英文名 string
courseEnd 结课时间 datetime
dateAdded 创建时间 datetime
isActive 是否活跃 boolean

根据英文名获取班级信息

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/schoolclass/{universityNameEn}/{classNameEn}

Body参数名 类型 必需 描述 示例 e.g.
universityNameEn string 校区英文名 ruc
classNameEn string 班级英文名 software-engineering-13

返回示例:

                    {
    "schoolClassId": 1,
    "icon": "http://images2015.cnblogs.com/blog/1/201604/1-20160430154644191-2093926076.png",
    "url": "/campus/ruc/software-engineering-13",
    "nameCn": "软件工程13级",
    "nameEn": "software-engineering-13",
    "postCount": 22,
    "memberCount": 0,
    "bulletinCount": 0,
    "universityId": 1,
    "creatorBlogId": 0,
    "lastPostTime": "2016-04-11T22:48:00",
    "universityNameCn": "中国人民大学",
    "universityNameEn": "ruc",
    "courseEnd": null,
    "dateAdded": "2017-06-29T19:27:24.2872093",
    "isActive": false
}
                            
Body参数名 描述 类型
schoolClassId 班级Id number
icon 班级图标 string
url 班级链接 string
nameCn 班级中文名 string
nameEn 班级英文名 string
postCount 博文数 number
memberCount 成员数 number
bulletinCount 公告数 number
universityId 校区Id number
creatorBlogId 创建者博客Id number
lastPostTime 最后发表博文时间 datetime
universityNameCn 校区中文名 string
universityNameEn 校区英文名 string
courseEnd 结课时间 datetime
dateAdded 创建时间 datetime
isActive 是否活跃 boolean

分页获取班级博文列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/schoolclass/posts/{filter}/{schoolClassId}/{pageIndex}-{pageSize}

Body参数名 类型 必需 描述 示例 e.g.
filter string 筛选条件 tutor
schoolClassId number 班级Id 1
pageIndex number 页码 1
pageSize number 页容量 10

详细说明:

筛选条件包含:no_comment(零回复)、tutor(老师/助教)、student(学生)、all(所有)

返回示例:

                    {
    "totalCount": 10,
    "blogPosts": [
        {
            "title": "结对编程之黄金分割",
            "url": "http://www.cnblogs.com/QuanQingli/p/5372570.html",
            "description": "结对编程之队友信息 队友:彭扬阳。博客地址http://www.cnblogs.com/zxyoyo/ 结对项目:黄金分割游戏。题目地址http://www.cnblogs.com/qingxu/p/5316897.html 结对编程之队友介绍 这次编程能很有幸和彭同学一组,彭同学平时是一个觉得沉默",
            "viewCount": 45,
            "diggCount": 0,
            "commentCount": 3,
            "author": "正能量制造机",
            "displayName": "正能量制造机(李全清)",
            "blogId": 269776,
            "blogUrl": "http://www.cnblogs.com/QuanQingli/",
            "avatarUrl": "/images/noavatar.png",
            "dateAdded": "2016-04-09T20:36:00"
        }
    ]
}
                            
Body参数名 描述 类型
totalCount 博文总数 number
blogPosts 博文列表 array
blogPosts.title 标题 string
blogPosts.url 链接 string
blogPosts.description 描述 string
blogPosts.viewCount 浏览数 number
blogPosts.diggCount 推荐数 number
blogPosts.commentCount 评论数 number
blogPosts.author 作者 string
blogPosts.displayName 显示名 string
blogPosts.blogId 博客Id number
blogPosts.blogUrl 博客链接 string
blogPosts.avatarUrl 作者头像 string
blogPosts.dateAdded 发表日期 datetime

分页获取班级评论列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/schoolclass/comments/{schoolClassId}/{pageIndex}-{pageSize}

Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 班级Id 1
pageIndex number 页码 1
pageSize number 页容量 10

返回示例:

                    {
    "totalCount": 10,
    "comments": [
        {
            "title": "Re:结对编程--黄金分割点游戏",
            "url": "http://www.cnblogs.com/sunle/p/5368754.html#3413603",
            "sourceUrl": "http://www.cnblogs.com/sunle/p/5368754.html",
            "formattedBody": "请按规范模式贴代码,必要时给出解释",
            "commenterName": "郑蕊",
            "commenterUrl": "http://www.cnblogs.com/zhengrui0452/",
            "commenterAvatar": "/images/noavatar.png",
            "dateAdded": "2016-04-20T20:19:17"
        }
    ]
}
                            
Body参数名 描述 类型
totalCount 评论总数 number
comments 评论列表 array
comments.title 标题 string
comments.url 链接 string
comments.sourceUrl 博文链接 string
comments.formattedBody 评论内容 string
comments.commenterName 评论人 string
comments.commenterUrl 评论人博客 string
comments.commenterAvatar 评论人头像 string
comments.dateAdded 评论时间 datetime

分页获取班级作业列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/schoolclass/homeworks/{withoutPostponed}/{schoolClassId}/{pageIndex}-{pageSize}

Body参数名 类型 必需 描述 示例 e.g.
withoutPostponed boolean 不显示未开始的作业 false
schoolClassId number 班级Id 1
pageIndex number 页码 1
pageSize number 页容量 10

返回示例:

                    {
    "totalCount": 10,
    "homeworks": [
        {
            "homeworkId": 9,
            "title": "作业要求 20170907",
            "url": "/campus/bjwzxy/test/homework/9",
            "description": "评分规则 截止时间前提交,有分。补交,0分; 先计为负分,一周内补交改为0分。晚交,倒扣; 迟于截止时间一周,倒扣本题分数。抄袭,倒扣本次作业分数。按教师和专家意见修改,在截止时间以前完成的,计入成绩。",
            "answerCount": 0,
            "isClosed": false,
            "displayName": "sun-le",
            "blogUrl": "http://www.cnblogs.com/sunle/",
            "avatarUrl": "/images/noavatar.png",
            "startTime": null,
            "deadline": "2017-09-10T17:00:00",
            "isFinished": false,
            "displayTime": "2017-09-10T16:24:05.2909972"
        }
    ]
}
                            
Body参数名 描述 类型
totalCount 作业总数 number
homeworks 作业列表 array
homeworks.homeworkId 作业Id number
homeworks.title 标题 string
homeworks.url 链接 string
homeworks.description 描述 string
homeworks.answerCount 答案数 number
homeworks.isClosed 是否关闭 boolean
homeworks.displayName 发布人 string
homeworks.blogUrl 发布人博客 string
homeworks.avatarUrl 发布人头像 string
homeworks.startTime 起始时间 datetime
homeworks.deadline 截止时间 datetime
homeworks.isFinished 是否完成 boolean
homeworks.displayTime 发布时间 datetime

分页获取班级公告列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/schoolclass/bulletins/{schoolClassId}/{pageIndex}-{pageSize}

Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 班级Id 1
pageIndex number 页码 1
pageSize number 页容量 10

返回示例:

                    {
    "totalCount": 10,
    "bulletins": [
        {
            "bulletinId": 10,
            "content": "沈航软件工程13级默认班级公告",
            "publisher": "sun-le",
            "blogUrl": "http://www.cnblogs.com/sunle/",
            "dateAdded": "2017-09-06T11:38:35.9192169"
        }
    ]
}
                            
Body参数名 描述 类型
totalCount 公告总数 number
bulletins 公告列表 array
bulletins.bulletinId 公告Id number
bulletins.content 内容 string
bulletins.publisher 发布者 string
bulletins.blogUrl 发布者博客 string
bulletins.dateAdded 发布时间 datetime

分页获取班级投票列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/schoolclass/votes/{schoolClassId}/{pageIndex}-{pageSize}

Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 班级Id 1
pageIndex number 页码 1
pageSize number 页容量 10

返回示例:

                    {
    "totalCount": 10,
    "votes": [
        {
            "voteId": 8,
            "name": "第一次作业情况调查",
            "url": "/campus/bjwzxy/test/vote/8",
            "description": "第一次作业已经开始,你觉得第一个编程题目如何?",
            "voteCount": 0,
            "blogUrl": "http://www.cnblogs.com/sunle/",
            "avatarUrl": "/images/noavatar.png",
            "displayName": "sun-le",
            "deadline": "2017-09-10T20:00:00",
            "dateAdded": "2017-09-09T18:01:46.011604",
            "isFinished": false
        }
    ]
}
                            
Body参数名 描述 类型
totalCount 投票总数 number
votes 投票列表 array
votes.voteId 投票Id number
votes.name 名称 string
votes.url 链接 string
votes.description 描述 string
votes.voteCount 参与数 number
votes.blogUrl 发起人博客 string
votes.avatarUrl 发起人头像 string
votes.displayName 发起人 string
votes.deadline 截止时间 datetime
votes.dateAdded 发起时间 datetime
votes.isFinished 是否完成 boolean

获取班级成员列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/schoolclass/members/{schoolClassId}?filter={filter}

Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 班级Id 1
filter string 筛选条件(昵称、姓名、学号) happylb

返回示例:

                    [
    {
        "memberId": 60,
        "studentNo": "1513933002",
        "realName": "胡玲碧",
        "displayName": "happylb",
        "blogId": 262939,
        "score": 138,
        "rank": 0,
        "postCount": 0,
        "blogUrl": "http://www.cnblogs.com/happylb/",
        "avatarUrl": "/images/noavatar.png",
        "membership": 1,
        "dateAdded": "2017-08-31T17:35:11.9467634"
    }
]
                            
Body参数名 描述 类型
memberId 成员Id number
studentNo 学号 string
realName 真实姓名 string
displayName 园子昵称 string
blogId 博客Id number
score 总得分 number
rank 优秀学生排名(1~10) number
postCount 博文数 number
blogUrl 博客链接 string
avatarUrl 头像链接 string
membership 身份(1.学生、2.老师、3.助教) number
dateAdded 创建时间 datetime

根据成员Id获取成员信息

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/member/{memberId}

Body参数名 类型 必需 描述 示例 e.g.
memberId number 成员Id 1

返回示例:

                    {
    "memberId": 1,
    "studentNo": "1513933002",
    "realName": "胡玲碧",
    "displayName": "happylb",
    "schoolClassId": 8,
    "membership": 1
}
                            
Body参数名 描述 类型
memberId 成员Id number
studentNo 学号 string
realName 真实姓名 string
displayName 园子昵称 string
schoolClassId 班级Id number
membership 身份(1.学生、2.老师、3.助教) number

根据博客Id获取成员信息

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/member/{blogId}/{schoolClassId}

Body参数名 类型 必需 描述 示例 e.g.
blogId string 博客Id 10000
schoolClassId string 班级Id 1

返回示例:

                    {
    "memberId": 60,
    "studentNo": "1513933002",
    "realName": "胡玲碧",
    "schoolClassId": 8,
    "membership": 1,
    "dateAdded": "2017-08-31T17:35:11.9467634"
}
                            
Body参数名 描述 类型
memberId 成员Id number
studentNo 学号 string
realName 真实姓名 string
schoolClassId 班级Id number
membership 身份(1.学生、2.老师、3.助教) number
dateAdded 创建时间 datetime

获取用户班级列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/member/schoolclasses

返回示例:

                    [
    {
        "schoolClassId": 1,
        "url": "/campus/ruc/software-engineering-13",
        "nameCn": "软件工程13级",
        "universityNameCn": "中国人民大学",
        "courseEnd": null
    }
]
                            
Body参数名 描述 类型
schoolClassId 班级Id number
url 班级链接 string
nameCn 班级中文名 string
universityNameCn 校区中文名 string
courseEnd 结课时间 datetime

按园子昵称添加成员

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/edu/member/register/displayName

Body
Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 操作人班级Id
displayName string 园子昵称
realName string 真实姓名
role number 身份(1.学生、2.老师、3.助教)
studentNo string 学号

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": false,
    "isWarning": true,
    "isError": false,
    "message": "您输入的园子昵称有误!"
}
                            

按博客链接添加成员

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/edu/member/register/blogUrl

Body
Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 操作人班级Id
blogUrl string 博客链接
realName string 真实姓名
role number 身份(1.学生、2.老师、3.助教)
studentNo string 学号

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

修改成员信息

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/edu/member/modify/{memberId}

Body
Body参数名 类型 必需 描述 示例 e.g.
memberId number 成员Id
schoolClassId number 操作人班级Id
realName string 真实姓名
role number 身份(1.学生、2.老师、3.助教)
studentNo string 学号(学生学号不允许修改)

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

删除班级成员

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/edu/member/remove/{schoolClassId}/{memberId}

Body参数名 类型 必需 描述 示例 e.g.
memberId number 成员Id
schoolClassId number 操作人班级Id
blogId number 操作人博客Id

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

根据Id获取作业信息

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/homework/{homeworkId}

Body参数名 类型 必需 描述 示例 e.g.
homeworkId number 作业Id 1

详细说明:

格式类型为markdown时,需要使用“convertedContent”字段来显示作业内容

返回示例:

                    {
    "homeworkId": 9,
    "title": "作业要求 20170907",
    "content": "<p>评分规则</p>\n<p>截止时间前提交,有分。<br />补交,0分; 先计为负分,一周内补交改为0分。<br />晚交,倒扣; 迟于截止时间一周,倒扣本题分数。<br />抄袭,倒扣本次作业分数。<br />按教师和专家意见修改,在截止时间以前完成的,计入成绩。</p>",
    "formatType": 1,
    "convertedContent": null,
    "description": "评分规则 截止时间前提交,有分。补交,0分; 先计为负分,一周内补交改为0分。晚交,倒扣; 迟于截止时间一周,倒扣本题分数。抄袭,倒扣本次作业分数。按教师和专家意见修改,在截止时间以前完成的,计入成绩。",
    "answerCount": 0,
    "isClosed": false,
    "publisher": "sun-le",
    "displayName": null,
    "blogUrl": "http://www.cnblogs.com/sunle/",
    "avatarUrl": null,
    "schoolClassId": 8,
    "startTime": null,
    "deadline": "2017-09-10T17:00:00",
    "isShowInHome": false,
    "isFinished": true,
    "displayTime": "2017-09-10T16:24:05.2909972"
}
                            
Body参数名 描述 类型
homeworkId 作业Id number
title 标题 string
content 内容 string
formatType 格式类型(1.TinyMce、2.Markdown) number
convertedContent markdown转换内容 string
description 描述 string
answerCount 答案数 number
isClosed 是否关闭 boolean
publisher 发布者 string
blogUrl 发布者博客 string
avatarUrl 发布者头像 string
schoolClassId 班级Id number
startTime 起始时间 datetime
deadline 截止时间 datetime
isShowInHome 是否首页显示 boolean
isFinished 是否完成 boolean
displayTime 发布时间 datetime

获取当前班级作业

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/homeworks/current/{schoolClassId}

Body参数名 类型 必需 描述 示例 e.g.
schoolClassId string 班级Id 1

返回示例:

                    [
    {
        "homeworkId": 10,
        "title": "使用markdown编辑器",
        "description": "使用markdown编辑器",
        "answerCount": 0,
        "publisher": "sun-le",
        "blogUrl": "http://www.cnblogs.com/sunle/",
        "displayTime": "2017-09-11T12:06:36.478281"
    }
]
                            
Body参数名 描述 类型
homeworkId 作业Id number
title 标题 string
description 描述 string
answerCount 答案数 number
publisher 发布者 string
blogUrl 发布者博客 string
displayTime 发布时间 datetime

获取答案提交列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/homework/answers/{homeworkId}

Body参数名 类型 必需 描述 示例 e.g.
homeworkId string 作业Id 1

返回示例:

                    [
    {
        "answerId": 2,
        "title": "软件工程-构建之法 团队",
        "url": "http://www.cnblogs.com/lisiyu/p/5419159.html",
        "remark": null,
        "score": null,
        "entryId": 23,
        "suggestion": null,
        "answererId": 69,
        "answerer": "lisiyu",
        "studentNo": "1513042005",
        "realName": "李思雨",
        "blogUrl": "http://www.cnblogs.com/lisiyu/",
        "dateAdded": "2017-09-02T19:07:16.1649235"
    }
]
                            
Body参数名 描述 类型
answerId 答案Id number
title 标题 string
url 链接 string
remark 学生备注 string
score 得分 number
entryId 博文Id number
suggestion 老师建议 string
answererId 学生Id number
answerer 学生 string
studentNo 学号 string
realName 真实姓名 string
blogUrl 学生博客 string
dateAdded 提交时间 datetime

发布作业

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/edu/homework/publish

Body
Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 操作人班级Id
title string 标题
startTime string 起始时间
deadline string 截止时间
content string 内容
formatType number 格式类型(1.TinyMce、2.Markdown)
IsShowInHome boolean 是否首页显示

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

编辑作业

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/edu/homework/edit/{homeworkId}

Body
Body参数名 类型 必需 描述 示例 e.g.
homeworkId number 作业Id
operatorInfo object 操作人信息
operatorInfo.schoolClassId number 操作人班级Id
operatorInfo.blogId number 操作人博客Id
title string 标题
startTime datetime 起始时间
deadline datetime 截止时间
content string 内容
formatType number 格式类型(1.TinyMce、2.Markdown)
IsShowInHome boolean 是否首页显示

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

关闭作业

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/edu/homework/close/{schoolClassId}/{homeworkId}

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

删除作业

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/edu/homework/remove/{schoolClassId}/{homeworkId}

Body参数名 类型 必需 描述 示例 e.g.
homeworkId string 作业Id
schoolClassId string 操作人班级Id

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

获取成员博文列表

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/answer/posts/{blogId}

Body参数名 类型 必需 描述 示例 e.g.
blogId number 博客Id 10000

返回示例:

                    [
    {
        "id": 3,
        "title": "软件工程学习进度条",
        "url": "http://www.cnblogs.com/sunle/p/5372010.html",
        "description": "第一周 第二周 第三周 第四周 第五周 第六周 学习时间 四小时 六小时 七小时 十二小时 十五小时 十五小时 代码量 100 100 150 150 200 200 博客量 100 200 200 300 300 400 学习到的知识 随机函数 四则运算与git的配置 git的使用 统计词频 网页",
        "viewCount": 10,
        "diggCount": 0,
        "commentCount": 0,
        "author": "sun-le",
        "blogUrl": "http://www.cnblogs.com/sunle/",
        "dateAdded": "2016-04-09T16:55:00"
    }
]
                            
Body参数名 描述 类型
id 博文Id number
title 标题 string
url 链接 string
description 描述 string
viewCount 浏览数 number
diggCount 推荐数 number
commentCount 评论数 number
author 作者 string
blogUrl 博客链接 string
dateAdded 发布时间 datetime

获取成员提交答案

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/{memberId}/{homeworkId}

Body参数名 类型 必需 描述 示例 e.g.
memberId number 成员Id 1
homeworkId number 作业Id 1

返回示例:

                    {
    "answerId": 2,
    "title": "软件工程-构建之法 团队",
    "url": "http://www.cnblogs.com/lisiyu/p/5419159.html",
    "remark": null,
    "score": null,
    "entryId": 23,
    "suggestion": null,
    "dateAdded": "2017-09-02T19:07:16.1649235"
}
                            
Body参数名 描述 类型
answerId 答案Id number
title 标题 string
url 链接 string
remark 学生备注 string
score 分数 number
entryId 博文Id number
suggestion 老师建议 string
dateAdded 提交时间 datetime

判断是否题交答案

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/answer/iscommitted/{memberId}/{homeworkId}

Body参数名 类型 必需 描述 示例 e.g.
memberId number 成员Id 1
homeworkId number 作业Id 1

返回示例:

                    true
                            

获取未提交答案成员

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/answer/uncommitted/{schoolClassId}/{homeworkId}

Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 班级Id 1
homeworkId number 作业Id 1

返回示例:

                    [
    {
        "memberId": 59,
        "studentNo": "1513012005",
        "realName": "彭瑶",
        "displayName": "彭瑶",
        "blogId": 268394,
        "score": null,
        "rank": 0,
        "postCount": 0,
        "blogUrl": "http://www.cnblogs.com/pytlr520/",
        "avatarUrl": "/images/noavatar.png",
        "membership": 1,
        "dateAdded": "2017-08-31T17:35:11.9273282"
    }
]
                            
Body参数名 描述 类型
memberId 成员Id number
studentNo 学号 string
realName 真实姓名 string
displayName 园子昵称 string
blogId 博客Id number
score 总分数 number
rank 优秀学生排名(1~10) number
postCount 博文数 number
blogUrl 博客链接 string
avatarUrl 头像链接 string
membership 身份(1.学生、2.老师、3.助教) number
dateAdded 创建时间 datetime

提交答案

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/edu/answer/commit

Body
Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 操作人班级Id
homeworkId number 作业Id
title string 标题
url string 链接
postId number 博文Id
remark string 备注

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

修改答案

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/edu/answer/modify/{answerId}

Body
Body参数名 类型 必需 描述 示例 e.g.
answerId number 答案Id
schoolClassId number 操作人班级Id
title string 标题
url string 链接
postId number 博文Id
remark string 备注

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

答案打分

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/edu/answer/marking/{answerId}

Body
Body参数名 类型 必需 描述 示例 e.g.
answerId number 答案Id
schoolClassId number 操作人班级Id
score number 分数

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

答案评语

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/edu/answer/suggest/{answerId}

Body
Body参数名 类型 必需 描述 示例 e.g.
answerId number 答案Id
schoolClassId number 操作人班级Id
suggestion string 评语

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

根据Id获取公告信息

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/bulletin/{bulletinId}

Body参数名 类型 必需 描述 示例 e.g.
bulletinId number 公告Id 1

返回示例:

                    "沈航软件工程13级默认班级公告"
                            

获取当前班级公告

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/bulletin/current/{schoolClassId}

Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 班级Id 1

返回示例:

                    "沈航软件工程13级默认班级公告"
                            

发布公告

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/edu/bulletin/publish

Body
Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 操作人班级Id
content string 内容

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

修改公告

在线测试 在线浏览

请求方式:PATCH

请求地址:https://api.cnblogs.com/api/edu/bulletin/modify/{bulletinId}

Body
Body参数名 类型 必需 描述 示例 e.g.
bulletinId number 公告Id
schoolClassId number 操作人班级Id
content string 内容

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

重发公告

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/edu/bulletin/republish/{schoolClassId}/{bulletinId}

Body参数名 类型 必需 描述 示例 e.g.
bulletinId number 公告Id
schoolClassId number 操作人班级Id

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

删除公告

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/edu/bulletin/remove/{schoolClassId}/{bulletinId}

Body参数名 类型 必需 描述 示例 e.g.
bulletinId number 公告Id
schoolClassId number 操作人班级Id
blogId number 操作人博客Id

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

根据Id获取投票信息

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/vote/{voteId}

Body参数名 类型 必需 描述 示例 e.g.
voteId number 投票Id 1

返回示例:

                    {
    "voteId": 8,
    "name": "第一次作业情况调查",
    "content": "第一次作业已经开始,你觉得第一个编程题目如何?",
    "description": "第一次作业已经开始,你觉得第一个编程题目如何?",
    "privacy": 1,
    "voteCount": 0,
    "blogUrl": "http://www.cnblogs.com/sunle/",
    "publisher": "sun-le",
    "publisherId": 45,
    "schoolClassId": 8,
    "deadline": "2017-09-10T20:00:00",
    "dateAdded": "2017-09-09T18:01:46.011604",
    "isFinished": true
}
                            
Body参数名 描述 类型
voteId 投票Id number
name 名称 string
content 内容 string
description 描述 string
privacy 隐私(1.公开、2.匿名) number
voteCount 参与数 number
blogUrl 发起人博客 string
publisher 发起人 string
publisherId 发起人Id number
schoolClassId 班级Id number
deadline 截止时间 datetime
dateAdded 发起时间 datetime
isFinished 是否完成 boolean

获取投票内容

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/vote/contents/{voteId}

Body参数名 类型 必需 描述 示例 e.g.
voteId number 投票Id 1

返回示例:

                    [
    {
        "voteContentId": 1,
        "title": "你觉得第一个编程题目如何?",
        "voteMode": 1,
        "picture": null,
        "voteId": 1,
        "voteOptions": [
            {
                "voteOptionId": 1,
                "option": "很容易,已经写好"
            },
            {
                "voteOptionId": 2,
                "option": "较难,我需要帮助才能写好"
            }
        ]
    }
]
                            
Body参数名 描述 类型
voteContentId 投票内容Id number
title 内容标题 string
voteMode 模式(1.单选、2.多选、3.排名) number
picture 图片链接 string
voteId 投票Id number
voteOptions 投票选项列表 array
voteOptions.voteOptionId 投票选项Id number
voteOptions.option 投票选项 string

获取投票选项记录

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/vote/record/{schoolClassId}/{voteOptionId}

Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 班级Id 1
voteOptionId number 投票选项Id 19

返回示例:

                    {
    "voteOption": "一般,我会写好的",
    "recordCount": 1,
    "votedMembers": [
        {
            "memberId": 1070,
            "studentNo": "1231242124",
            "realName": "李思雨",
            "displayName": "lisiyu",
            "blogId": 270178,
            "postCount": 1,
            "blogUrl": "http://www.cnblogs.com/lisiyu/",
            "avatarUrl": "/images/noavatar.png",
            "membership": 1
        }
    ]
}
                            
Body参数名 描述 类型
voteOption 投票选项 string
recordCount 投票数 number
votedMembers 投票人列表 array
votedMembers.memberId 成员Id number
votedMembers.studentNo 学号 string
votedMembers.realName 真实姓名 string
votedMembers.displayName 园子昵称 string
votedMembers.blogId 博客Id number
votedMembers.postCount 博文数 number
votedMembers.blogUrl 博客链接 string
votedMembers.avatarUrl 头像链接 string
votedMembers.membership 身份(1.学生、2.老师、3.助教) number

获取投票统计

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/vote/stats/{voteId}

Body参数名 类型 必需 描述 示例 e.g.
voteId number 投票Id 1

详细说明:

非排名模式无需“scoreValue”字段

返回示例:

                    {
    "1": [
        {
            "voteOptionId": 21,
            "voteOption": "No.2 web前端开发",
            "recordCount": 0,
            "percent": 0,
            "scoreValue": 0
        },
        {
            "voteOptionId": 22,
            "voteOption": "No.1 后端开发",
            "recordCount": 0,
            "percent": 0,
            "scoreValue": 0
        },
        {
            "voteOptionId": 23,
            "voteOption": "No.3 软件测试",
            "recordCount": 1,
            "percent": 100,
            "scoreValue": 0
        }
    ]
}
                            
Body参数名 描述 类型
1 投票内容Id string
voteOptionId 投票选项Id number
voteOption 投票选项 string
recordCount 投票数 number
percent 百分比 number
scoreValue 分值 string

获取当前班级投票

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/votes/current/{schoolClassId}

Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 班级Id 1

返回示例:

                    [
    {
        "voteId": 8,
        "name": "第一次作业情况调查",
        "description": "第一次作业已经开始,你觉得第一个编程题目如何?",
        "voteCount": 1,
        "blogUrl": "http://www.cnblogs.com/sunle/",
        "publisher": "sun-le",
        "dateAdded": "2017-09-10T18:01:46.011604"
    }
]
                            
Body参数名 描述 类型
voteId 投票Id number
name 名称 string
description 描述 string
voteCount 参与数 number
blogUrl 发起人博客 string
publisher 发起人 string
dateAdded 发起时间 datetime

判断是否参与投票

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/vote/iscommitted/{memberId}/{voteId}

Body参数名 类型 必需 描述 示例 e.g.
memberId number 成员Id 1
voteId number 投票Id 1

返回示例:

                    false
                            

获取参与投票成员

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/vote/committed/members/{schoolClassId}/{voteId}

Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 班级Id 1
voteId number 投票Id 1

返回示例:

                    [
    {
        "memberId": 1070,
        "studentNo": "1231242124",
        "realName": "李思雨",
        "displayName": "lisiyu",
        "blogId": 270178,
        "postCount": 1,
        "blogUrl": "http://www.cnblogs.com/lisiyu/",
        "avatarUrl": "/images/noavatar.png",
        "membership": 1
    }
]
                            
Body参数名 描述 类型
memberId 成员Id number
studentNo 学号 string
realName 真实姓名 string
displayName 园子昵称 string
blogId 博客Id number
postCount 博文数 number
blogUrl 博客链接 string
avatarUrl 头像链接 string
membership 身份(1.学生、2.老师、3.助教) number

获取成员投票项

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/edu/vote/committed/options/{memberId}/{voteId}

Body参数名 类型 必需 描述 示例 e.g.
memberId number 成员Id 1
voteId number 投票Id 1

返回示例:

                    {
    "1": [
        "一般,我会写好的"
    ]
}
                            
Body参数名 描述 类型
1 投票内容Id array

发起投票

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/edu/vote/publish

Body
Body参数名 类型 必需 描述 示例 e.g.
schoolClassId number 操作人班级Id
name string 名称
content string 内容
privacy number 隐私(1.公开、2.匿名)
deadline string 截止时间
voteContents array 投票内容列表
voteContents.title string 标题
voteContents.voteMode number 模式(1.单选、2.多选)
voteContents.picture string 图片链接
voteContents.voteOptions array 投票选项列表
voteContents.voteOptions.option string 投票选项

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

参与投票

在线测试 在线浏览

请求方式:POST

请求地址:https://api.cnblogs.com/api/edu/vote/commit/{voteId}

Body
Body参数名 类型 必需 描述 示例 e.g.
voteId number 投票Id
schoolClassId number 操作人班级Id
voteOptionIds array 投票选项Id列表

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

删除投票

在线测试 在线浏览

请求方式:DELETE

请求地址:https://api.cnblogs.com/api/edu/vote/remove/{schoolClassId}/{voteId}

详细说明:

返回值“isWarning”为true时,则对应“message”字段中的内容

返回示例:

                    {
    "isSuccess": true,
    "isWarning": false,
    "isError": false,
    "message": null
}
                            

ZzkDocument

找找看

在线测试 在线浏览

请求方式:GET

请求地址:https://api.cnblogs.com/api/ZzkDocuments/{category}?keyWords={keyWords}&pageIndex={pageIndex}&startDate={startDate}&endDate={endDate}&viewTimesAtLeast={viewTimesAtLeast}

Body参数名 类型 必需 描述 示例 e.g.
category string 搜索类别 可选参数(Blog,News,Question,Kb)
keyWords string 搜索关键字 .net
pageIndex number 要返回的页次,如果不提供页次,则为默认值1 1
startDate date 开始时间,如果不提供日期,则显示所有搜索结果日期格式: 2015-09-09 2015-09-09
endDate date 结束日期,如果不提供日期,则截止到当前日期日期格式: 2015-09-09 2015-09-09
viewTimesAtLeast string 搜索浏览次数在此以上的内容 10

详细说明:

查询结果:
 如果关键字为空,则返回 StatusCode:BadRequest400. 
如果搜索类别不支持,则返回 StatusCode:BadRequest400. 
如果查询结果为空,则返回StatusCode:Ok200.但HttpContent为空。

返回示例:

                    [
  {
    "Title": "sample string 1",
    "Content": "sample string 2",
    "UserName": "sample string 3",
    "UserAlias": "sample string 4",
    "PublishTime": "2017-06-25T10:03:46.4250727+08:00",
    "VoteTimes": 6,
    "ViewTimes": 7,
    "CommentTimes": 8,
    "Uri": "sample string 9",
    "Id": "sample string 10"
  },
  {
    "Title": "sample string 1",
    "Content": "sample string 2",
    "UserName": "sample string 3",
    "UserAlias": "sample string 4",
    "PublishTime": "2017-06-25T10:03:46.4250727+08:00",
    "VoteTimes": 6,
    "ViewTimes": 7,
    "CommentTimes": 8,
    "Uri": "sample string 9",
    "Id": "sample string 10"
  }
]
                            
Body参数名 描述 类型
Title 查询内容的标题 string
Content 查询内容摘要 string
UserName 作者 string
UserAlias 博客地址 string
PublishTime 发布时间 string
VoteTimes 被推荐次数 number
ViewTimes 浏览次数 number
CommentTimes 评论次数 number
Uri 页面链接 string
Id string

附录

环境变量

目录