Skip to content

Commit 90b0d9d

Browse files
committed
feat: update Scraper API documentation and add new reader endpoint
- Add new endpoint for the Reader API to the documentation - Update existing Search API route to include versioning - Enhance overall clarity and structure of the API reference
1 parent 5d99b35 commit 90b0d9d

File tree

4 files changed

+32
-16
lines changed

4 files changed

+32
-16
lines changed

content/docs/api-reference/meta.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"---Scraper API---",
2323
"scraper/overview",
2424
"scraper/authentication",
25-
"scraper/web/post",
26-
"scraper/search/post"
25+
"scraper/search/post",
26+
"scraper/reader/post"
2727
]
2828
}
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
title: 网页内容爬取
3-
description: 提供网页链接,返回可读的网页内容
3+
description: 提供搜索关键词,返回搜索结果
44
full: true
55
_openapi:
66
method: POST
7-
route: /scraper/web
7+
route: /v1/reader
88
toc: []
99
structuredData:
1010
headings: []
1111
contents:
12-
- content: 提供网页链接,返回可读的网页内容
12+
- content: 提供搜索关键词,返回搜索结果
1313
---
1414

1515
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
1616

17-
<APIPage document={"./scripts/scraper.openapi.json"} operations={[{"path":"/scraper/web","method":"post"}]} webhooks={[]} hasHead={false} />
17+
<APIPage document={"./scripts/scraper.openapi.json"} operations={[{"path":"/v1/reader","method":"post"}]} webhooks={[]} hasHead={false} />

content/docs/api-reference/scraper/search/post.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: 提供搜索关键词,返回搜索结果
44
full: true
55
_openapi:
66
method: POST
7-
route: /scraper/search
7+
route: /v1/search
88
toc: []
99
structuredData:
1010
headings: []
@@ -14,4 +14,4 @@ _openapi:
1414

1515
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
1616

17-
<APIPage document={"./scripts/scraper.openapi.json"} operations={[{"path":"/scraper/search","method":"post"}]} webhooks={[]} hasHead={false} />
17+
<APIPage document={"./scripts/scraper.openapi.json"} operations={[{"path":"/v1/search","method":"post"}]} webhooks={[]} hasHead={false} />

scripts/scraper.openapi.json

Lines changed: 24 additions & 8 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)