docs: 更新API token相关文档

Mereithhh · Mar 17, 2023 · 0d8d04d · 0d8d04d
1 parent 287e9b1
commit 0d8d04d
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 9 deletions.
diff --git a/docs/advanced/token.md b/docs/advanced/token.md
@@ -0,0 +1,13 @@
+---
+title: API Token 管理
+icon: key
+---
+
+
+VanBlog 致力于成为一个高扩展、API First 的博客系统，虽然现在 API 文档还不够完，但也可以用了。
+
+你可以在后台的 `系统设置/Token 管理` 中对 API Token 进行管理。
+
+![](https://pic.mereith.com/img/d78409dcfb170ea71289ac38d9430165.clipboard-2023-03-17.png)
+
+> [API 参考](/reference/api.md)
diff --git a/docs/reference/api.md b/docs/reference/api.md
@@ -7,25 +7,24 @@ redirectFrom: /ref/api.html
 
 目前还没写专门的 API 参考，但是可以用生成的 `swagger` 做为参考。其中 `public` 标签下的都是不需要鉴权的。
 
-可以在后台侧边栏中点击关于，然后点击关于界面的 `API 文档` 来进入 API 文档页面：
+## API 文档入口
 
-![API 文档入口](https://pic.mereith.com/img/0b487fe87735562feff3825b040c5353.clipboard-2022-08-29.png)
+你可以在后台的 `系统设置/Token 管理` 中点击 `API 文档` 进入此 Vanblog 对应的 API 文档。
 
-由于分离式的设计，你完全可以把本项目当作无头 CMS 来使用。只用本项目的后端和 server，自己写前端，或者自己写一个 `hexo` 的渲染器。
-
-（也许以后我会加上一些其他的渲染器支持，比如对接 `hexo` 和 `vuepress`）
+![](https://pic.mereith.com/img/d78409dcfb170ea71289ac38d9430165.clipboard-2023-03-17.png)
 
 ::: note
 
 - swagger 路径： `/swagger`
-- 参考： [https://blog-demo.mereith.com/swagger](https://blog-demo.mereith.com/swagger)
+- 参考（demo 站的）： [https://blog-demo.mereith.com/swagger](https://blog-demo.mereith.com/swagger)
 
 :::
 
 举个例子，你可以通过 `GET /api/public/article/:id` ，获取置顶文章的 JSON 内容。
 
 你可以点击这个链接看一下效果： [https://blog-demo.mereith.com/api/public/article/28](https://blog-demo.mereith.com/api/public/article/28)
 
-## 关于鉴权的接口
+## 鉴权
+
+所有需要鉴权的接口是通过 `请求头` 中 `token` 字段鉴权的，你可以在后台的 `系统设置/Token 管理` 中进行管理。
 
-所有需要鉴权的接口是通过请求头中 `token` 字段鉴权的，可以复制登录后台后的请求头中的 `token` 来使用鉴权 API，有效期和登录过期时间相同，可通过后台中的高级设置调整过期时间。
diff --git a/packages/admin/src/pages/SystemConfig/tabs/Token.tsx b/packages/admin/src/pages/SystemConfig/tabs/Token.tsx
@@ -70,7 +70,7 @@ export default function () {
                         <a
                           target="_blank"
                           rel="noreferrer"
-                          href="https://vanblog.mereith.com/reference/api.html"
+                          href="https://vanblog.mereith.com/advanced/token.html"
                         >
                           相关文档
                         </a>