Skip to content

Latest commit

 

History

History
248 lines (180 loc) · 5.03 KB

API.md

File metadata and controls

248 lines (180 loc) · 5.03 KB
Raw

API 接口

规范

遵守 RESTful 规范

成功 (如文档无示例) 默认返回

{
  "status": true
}

失败默认返回

{
  "message": "error-message"
}

并按请求类型提供状态码

公开

获取精选博客

GET /featured-blogs

返回

[
  {
    // 使用 uuid4 算法生成的 id
    "id": "1064f634-f899-4048-8b0d-ce9f124d98b4",
    // 表示顺序的数字（非连续）
    "idx": 1,
    // 博客网站的名称
    "name": "卷土",
    // 博客网站的网址
    "url": "https://juantu.cn/",
    // 元素为博客标签的数组
    "tags": ["综合", "Python", "科技", "杂录"],
    // 博客网站的一句话介绍
    "sign": "现只为做成一件事"
  }
  // ...
]

获取随机博客数据

GET /random-blogs

请求

键 描述 是否必填 类型 备注
tags 筛选博客的标签 否 string 不同标签之间用英文逗号分隔
count 获取数据的个数 否 number

返回

同 获取精选博客

获取全部博客

GET /blogs

请求

键 描述 是否必填 类型 备注
search 筛选博客的关键词 否 string
tags 筛选博客的标签 否 string 不同标签之间用英文逗号分隔
status 筛选博客的状态 否 number 0 全部，1 审核通过，-1 审核不通过，2 推荐
offset 偏移量 否 number 用于博客的分页展示
size 返回博客的个数 否 number

返回

{
  "total": 1694,
  "blogs": [
    {
      "id": "1064f634-f899-4048-8b0d-ce9f124d98b4",
      "idx": 1,
      "name": "卷土",
      "url": "https://juantu.cn/",
      "tags": ["综合", "Python", "科技", "杂录"],
      "sign": "现只为做成一件事",
      // 博客网站的订阅地址
      "feed": "https://juantu.cn/feed"
    }
    // ...
  ]
}
以下API为旧版，待审核修改

获取博客标签列表

GET /tags

返回

博客标签的数组

["综合", "Python"]

获取架构统计信息

GET /archs

返回

[
  {
    // 架构名称
    "name": "WordPress",
    // 架构使用人数
    "count": 285,
    // 架构简介
    "description": "WordPress 是一款能让您建立出色网站、博客或应用程序的开源软件。",
    // 架构官网
    "url": "https://cn.wordpress.org/"
  }
]

获取顶级域名统计信息

GET /domains

返回

[
  {
    // 顶级域名
    "name": "cn",
    // 使用人数
    "count": 290
  }
]

后台

Note
以下请求中 Cookies 需携带 GitHub OAuth 的 token

鉴权

GET /admin/whoami

请求

无请求主体，仅验证 Cookies 中 token 是否合法

返回

{
  "username": "jsun969",
  "permission": "owner/member/collaborator"
}

新增博客

POST /admin/blog

请求

{
  // 博客网站的名称
  "name": "卷土",
  // 博客网站的网址
  "url": "https://juantu.cn/",
  // 元素为博客标签的数组
  "tags": ["综合", "Python", "科技", "杂录"],
  // 博客网站的一句话介绍
  "sign": "现只为做成一件事",
  // 博客网站的订阅地址
  "feed": "https://juantu.cn/feed",
  // 博客网站的网站地图地址
  "sitemap": "https://juantu.cn/sitemap.xml",
  // 博客网站的架构
  "arch": "WordPress"
}

修改博客信息

PATCH /admin/blog

请求

键 描述 是否必填 类型 备注
id 目标博客的编号 是 number
key 需要修改的信息项名称 是 string 例如name
value 需要修改的信息项的内容 是 srting 例如卷土

删除博客信息

DELETE /admin/blog

请求

键 描述 是否必填 类型
id 目标博客的编号 是 number

删除标签

DELETE /admin/tag

请求

键 描述 是否必填 类型 备注
tag 目标标签 是 string 例如Python

[仅 Owner] 添加管理员 (Collaborator) GitHub 用户名

PUT /admin/github-username

请求

{
  "username": "jsun969"
}