个人博客集成语雀文档开发博文管理

语雀AccesToken开发策略

在开发自己博客过程中，为了避免重复造轮子，使用语雀提供的文档管理可以实时的追踪到自己的数据库中。只需要自己开发好前端页面就可以获取到。

1.创建并申请Token

申请AccesToken 设置Token权限

Token asdklfjasdpoigjwejfal;skjdfoisdj

主要的权限有：

✅修改和读取你的团队✅读取你的团队

✅修改和读取你的主题✅读取你的主题

✅修改和读取你的知识库✅读取你的知识库

✅修改和读取你的文档✅读取你的文档

✅修改和读取你的画板✅读取你的画板

2.数据请求准备

基本路径

https://www.yuque.com/api/v2

所有API都以上述路径开头

HTTP方法

Verb	Description
GET	用于获取数据
POST	用于创建数据
PUT	用于修改部分数据，例如一个文档标题，正文
DELETE	用于删除数据

提交数据说明

当使用POST 和PUT方法时，请确保Content-type 为 application/json

User-Agent

每次请求数据必须携带User-Agent 以确保语雀了解请求用户是谁

req.Headers.Add("User-Agent", "这里可以填应用名称")

Token认证

语雀使用Token认证，需要在HTTP Headers中传入 X-Auth-TokenToken

HTTP状态码

200-成功
400-请求的参数不正确，或缺少必要信息，请对比文档
401-需要用户认证的接口用户信息不正确
403-缺少对应功能的权限
404-数据不存在，或未开放
500-服务器异常

3.接口使用

获取当前Token的用户信息

GET /user

Response

{"data": {"id": 6,"type": "User","login": "huacnlee","name": "李华顺","description": null,"avatar_url": "https://...png","created_at": "2016-08-19T01:37:44.000Z","updated_at": "2016-09-08T18:55:52.000Z"}
}

必须存储 :id :login 请求过程中会经常使用

获取基于用户的仓库目录

GET /users/:id/repos

Response

Array

{"data": [{"id": 100,"name": "某某仓库","slug": "notes","namespace": "foo/notes","description": "",},{ ... }]
}

获取仓库下的所有文档

GET /repos/:id/docs

Response

Array

{  "data": [    {      "id": 100,      "title": "快速开始",      "slug": "get-stared",      "status": 1,      "public": 1,      "created_at": "2016-09-06T23:44:00.000Z",      "updated_at": "2016-09-06T23:44:00.000Z"    }  ]}

获取单篇的文档

GET /repos/:namespace/docs/:slug

Response

{  "data": [    {      "id": 100,      "title": "快速开始",      "slug": "get-stared",      "status": 1,      "public": 1,      "created_at": "2016-09-06T23:44:00.000Z",      "updated_at": "2016-09-06T23:44:00.000Z"    }  ]}

4业务逻辑设计

追踪某篇文档

返回所有仓库-->             返回仓库下所有文档-->                             返回文档序列-->                                确定某个文档，存储repos_id 和 doc_id

根据当前Token获取用户ID–>

return UserSerializer

请求所有仓库–>

return BookSerializer

请求单个仓库下所有文档列表–>

return DocSerializers

查看单个文档详情–>

return DocDetailsSerializers

推送更新文档

webhook推送–>

记录计算推送日志

判断是否是追踪库–>是，更新相关文档

否，不更新；