Typecho-API 使用方法

Typecho-API 使用方法，包含了文章的增删改查，通过api可以方便的操作自己的博客。

认证

大多数接口需要基于令牌的认证。确保在您的请求头中包含有效的令牌。

介绍

• 获取所有文章的接口：/api/posts
• 获取单个文章的接口：/api/posts/{id}
• 创建新文章的接口：/api/posts
• 更新文章的接口：/api/posts/{id}
• 删除文章的接口：/api/posts/{id}

通过这几个api，可以自由的操作typecho博客的文章，当然，使用场景最多的应该是添加文章的接口，通过这个接口可以配合很多工具自由的添加文章，例如

• iphone手机的快捷指令
• uTools的随手记录
• Chrome浏览器的插件
• 等等可以发送请求的场景

添加文章的请求示例

curl --location 'https://type-note.glwsq.cn/typecho-api/posts' \
--header 'authorization: SHA-256编码的token' \
--header 'Content-Type: application/json' \
--data '{
    "text": "文章内容",
    "title": "文章标题",
    "categoryName": "API笔记",
    "tagNames": ["api添加"]
}'

参数说明：

• text 是必须的，其他都是可选的

接口使用方法

1. Hash SHA-256

• 接口： /api/hash-sha256
• 方法： GET
• 描述： 返回提供数据的 SHA-256 哈希。

• 查询参数：

  • data（字符串）：要哈希的数据。

• 响应：

  • hash（字符串）：提供数据的 SHA-256 哈希。

2. 上传文件

• 接口： /api/upload
• 方法： POST
• 描述： 上传图片文件。

• 表单数据：

  • image（文件）：要上传的图片文件。
  • note_id（字符串，可选）：笔记的 ID。
  • newFileName（字符串，可选）：文件的新名称。

• 响应：

  • imageUrl（字符串）：上传图片的 URL。
  • attachmentId（整型）：新附件的 ID。

3. 获取文章

• 接口： /api/posts
• 方法： GET
• 描述： 检索所有文章。

• 查询参数：

  • page（整型，可选）：页码。
  • per_page（整型，可选）：每页文章数量。
  • q（字符串，可选）：搜索查询。
  • sort_by（字符串，可选）：排序字段。
  • sort_order（字符串，可选）：排序顺序（asc 或 desc）。
  • modified_threshold（整型，可选）：修改文章的阈值。

• 响应：

  • 带分页详情的文章列表。

4. 获取单个文章

• 接口： /api/posts/<int:id>
• 方法： GET
• 描述： 通过 ID 检索单个文章。

• URL 参数：

  • id（整型）：文章的 ID。

• 响应：

  • 请求文章的详细信息。

5. 创建新文章

• 接口： /api/posts
• 方法： POST
• 描述： 创建新文章。

• JSON 主体：

  • text（字符串）：文章内容。
  • title（字符串，可选）：文章标题。
  • authorId（整型，可选）：作者的 ID。
  • categoryName（字符串，可选）：类别名称。
  • tagNames（数组，可选）：标签名称列表。
  • note_id（字符串，可选）：唯一笔记 ID。

• 响应：

  • 创建文章的详细信息。

6. 更新文章

• 接口： /api/posts/<int:id>
• 方法： PUT
• 描述： 更新现有文章。

• URL 参数：

  • id（整型）：要更新的文章 ID。

• JSON 主体：

  • 与创建新文章相同。

• 响应：

  • 更新文章的详细信息。

7. 删除文章

• 接口： /api/posts/<int:id>
• 方法： DELETE
• 描述： 删除文章。

• URL 参数：

  • id（整型）：要删除的文章 ID。
• 响应：