描述：${item.find('.abstract').text()}
.data('echo')})
`,
+ // 文章发布时间
+ pubDate: new Date(item.find('.time').data('shared-at')).toUTCString(),
+ // 文章链接
+ link: `https://www.jianshu.com${item.find('.title').attr('href')}`,
+ };
+ })
+ .get(), // cheerio get() 方法将 cheerio node 对象数组转换为 node 对象数组
+ };
-添加缓存:
+ // 至此本路由结束
+ ```
+
+ 3. **使用 puppeteer 渲染页面获取数据**
+
+ ::: tip 提示
+
+ 由于此方法性能较差且消耗较多资源，使用前请确保以上两种方法无法获取数据，不然将导致您的 pull requests 被拒绝！
+
+ :::
+
+ 部分网站**没有接口供调用，且页面需要渲染**才能获取正确的 HTML，
+ 样例：[/routes/sspai/series.js](https://github.com/DIYgod/RSSHub/blob/master/routes/sspai/series.js)
+
+ ```js
+ // 使用 RSSHub 提供的 puppeteer 工具类，初始化 Chrome 进程
+ const browser = await require('../../utils/puppeteer')();
+ // 创建一个新的浏览器页面
+ const page = await browser.newPage();
+ // 访问指定的链接
+ const link = 'https://sspai.com/series';
+ await page.goto(link);
+ // 渲染目标网页
+ const html = await page.evaluate(
+ () =>
+ // 选取渲染后的 HTML
+ document.querySelector('div.new-series-wrapper').innerHTML
+ );
+ // 关闭浏览器进程
+ browser.close();
+ ```
+
+ 使用 cheerio 解析返回的 HTML:
+
+ ```js
+ const $ = cheerio.load(html); // 使用 cheerio 加载返回的 HTML
+ const list = $('div.item'); // 使用 cheerio 选择器，选择所有 元素，返回 cheerio node 对象数组
+ ```
+
+ 赋值给 `ctx.state.data`
+
+ ```js
+ ctx.state.data = {
+ title: '少数派 -- 最新上架付费专栏',
+ link,
+ description: '少数派 -- 最新上架付费专栏',
+ item: list
+ .map((i, item) => ({
+ // 文章标题
+ title: $(item)
+ .find('.item-title a')
+ .text()
+ .trim(),
+ // 文章链接
+ link: url.resolve(
+ link,
+ $(item)
+ .find('.item-title a')
+ .attr('href')
+ ),
+ // 文章作者
+ author: $(item)
+ .find('.item-author')
+ .text()
+ .trim(),
+ }))
+ .get(), // cheerio get() 方法将 cheerio node 对象数组转换为 node 对象数组
+ };
+
+ // 至此本路由结束
+
+ // 注：由于此路由只是起到一个新专栏上架提醒的作用，无法访问付费文章，因此没有文章正文
+ ```
+
+#### 使用缓存
+
+所有路由都有一个缓存，全局缓存时间在 `config.js` 里设定，但某些接口返回的内容更新频率较低，这时应该给这些数据设置一个更长的缓存时间。
+
+- 添加缓存:
```js
ctx.cache.set((key: string), (value: string), (time: number)); // time 为缓存时间, 单位为秒
```
-获取缓存:
+- 获取缓存:
```js
const value = await ctx.cache.get((key: string));
```
-可以直接看这个典型的例子: [/routes/zhihu/daily.js](https://github.com/DIYgod/RSSHub/blob/master/routes/zhihu/daily.js), 这个例子中需要获取每篇文章的详细内容, 每篇文章都需要单独请求一次, 请求很多而且每个请求只需要一次, 这时候可以把结果缓存一天.
+例如知乎日报需要获取文章全文：[/routes/zhihu/daily.js](https://github.com/DIYgod/RSSHub/blob/master/routes/zhihu/daily.js), 每篇文章都需要单独请求一次。
-### 数据
+由于已知文章更新频率为一天，把结果缓存一天，可以让后续的请求直接使用已缓存的数据，从而提升性能并节省资源。
-获取到的数据赋给 ctx.state.data, 然后数据会经过 [template.js](https://github.com/DIYgod/RSSHub/blob/master/middleware/template.js) 中间件处理, 最后传到 [/views/rss.art](https://github.com/DIYgod/RSSHub/blob/master/views/rss.art) 来生成最后的 RSS 结果, 每个字段的含义如下:
+```js
+const key = 'daily' + story.id; // story.id 为知乎日报返回的文章唯一识别符
+ctx.cache.set(key, item.description, 24 * 60 * 60); // 设置缓存时间为 24小时 * 60分钟 * 60秒 = 86400秒/1天
+```
+
+当同样的请求被发起时，优先使用未过期的缓存：
+
+```js
+const key = 'daily' + story.id;
+const value = await ctx.cache.get(key); // 从缓存中查询是否已存在该文章唯一识别符
+if (value) {
+ // 查询返回未过期缓存
+ item.description = value; // 直接赋值
+} else {
+ // 查询未发现未过期缓存
+ // 向数据源发起请求
+}
+```
+
+#### 生成 RSS
+
+获取到的数据赋给 ctx.state.data, 然后数据会经过 [template.js](https://github.com/DIYgod/RSSHub/blob/master/middleware/template.js) 中间件处理，最后传到 [/views/rss.art](https://github.com/DIYgod/RSSHub/blob/master/views/rss.art) 来生成最后的 RSS 结果，每个字段的含义如下：
```js
ctx.state.data = {
@@ -118,15 +274,15 @@ ctx.state.data = {
};
```
-
+#### 制作播客 Podcast Feed -参考文章: +参考文章： - [Podcasts Connect 帮助 创建播客 - Apple](https://help.apple.com/itc/podcasts_connect/#/itca5b22233a) - RSS 格式参考: https://codepen.io/jon-walstedt/pen/jsIup - 播客验证: https://podba.se/validate/?url=https://rsshub.app/ximalaya/album/299146/ -这些字段能使你的 RSS 被泛用型播客软件订阅: +这些字段能使你的 RSS 被泛用型播客软件订阅： ```js ctx.state.data = { @@ -154,7 +310,124 @@ ctx.state.data = { }; ``` -
+### 步骤 2: 添加脚本路由
+
+在 [/router.js](https://github.com/DIYgod/RSSHub/blob/master/router.js) 里添加路由：
+
+#### 举例
+
+1. [bilibili/bangumi](https://github.com/DIYgod/RSSHub/blob/master/routes/bilibili/bangumi.js)
+
+| 类型 | 代码 |
+| ---------------------- | ---------------------------------------------------------------------------------- |
+| 路由 | `/bilibili/bangumi/:seasonid` |
+| 数据来源 | bilibili |
+| 路由名称 | bangumi |
+| 参数 1 | :seasonid 必选 |
+| 参数 2 | 无 |
+| 参数 3 | 无 |
+| 脚本路径 | `./routes/bilibili/bangumi` |
+| router.js 中的完整代码 | `router.get('/bilibili/bangumi/:seasonid', require('./routes/bilibili/bangumi'));` |
+
+1. [github/issue](https://github.com/DIYgod/RSSHub/blob/master/routes/github/issue.js)
+
+| 类型 | 代码 |
+| ---------------------- | ---------------------------------------------------------------------------- |
+| 路由 | `/github/issue/:user/:repo` |
+| 数据来源 | github |
+| 路由名称 | issue |
+| 参数 1 | :user 必选 |
+| 参数 2 | :repo 必选 |
+| 参数 3 | 无 |
+| 脚本路径 | `./routes/github/issue` |
+| router.js 中的完整代码 | `router.get('/github/issue/:user/:repo', require('./routes/github/issue'));` |
+
+1. [embassy](https://github.com/DIYgod/RSSHub/blob/master/routes/embassy/index.js)
+
+| 类型 | 代码 |
+| ---------------------- | ---------------------------------------------------------------------------- |
+| 路由 | `/embassy/:country/:city?` |
+| 数据来源 | embassy |
+| 路由名称 | 无 |
+| 参数 1 | :country 必选 |
+| 参数 2 | ?city 可选 |
+| 参数 3 | 无 |
+| 脚本路径 | `./routes/embassy/index` |
+| router.js 中的完整代码 | `router.get('/embassy/:country/:city?', require('./routes/embassy/index'));` |
+
+### 步骤 3: 添加脚本文档
+
+1. 更新 [文档 (/docs/README.md) ](https://github.com/DIYgod/RSSHub/blob/master/docs/README.md), 可以执行 `npm run docs:dev` 查看文档效果
+
+ - 文档采用 vue 组件形式，格式如下：
+ - `name`: 路由名称
+ - `author`: 路由作者，多位作者使用单个空格分隔
+ - `example`: 路由举例
+ - `path`: 路由路径
+ - `:paramsDesc`: 路由参数说明，数组，支持 markdown
+ 1. 参数说明必须对应其在路径中出现的顺序
+ 1. 如缺少说明将会导致`npm run docs:dev`报错
+ 1. 说明中的 `'` `"` 必须通过反斜杠转义 `\'` `\"`
+ 1. 不必在说明中标注`可选/必选`，组件会根据路由`?`自动判断
+ - 文档样例：
+
+ 1. 多参数：
+
+ ```vue
+
+
+ | 前端 | Android | iOS | 后端 | 设计 | 产品 | 工具资源 | 阅读 | 人工智能 |
+ | -------- | ------- | --- | ------- | ------ | ------- | -------- | ------- | -------- |
+ | frontend | android | ios | backend | design | product | freebie | article | ai |
+
+
+ ```
+
+ 结果预览：
+
+ ***
+
+
+
+ | 前端 | Android | iOS | 后端 | 设计 | 产品 | 工具资源 | 阅读 | 人工智能 |
+ | -------- | ------- | --- | ------- | ------ | ------- | -------- | ------- | -------- |
+ | frontend | android | ios | backend | design | product | freebie | article | ai |
+
+
+
+ ***
+
+1. 执行 `npm run format` 自动标准化代码格式，提交代码, 然后提交 pull request
## 参与讨论
如果你想制作podcast feed, 点这儿
+#### 制作播客 Podcast Feed -参考文章: +参考文章： - [Podcasts Connect 帮助 创建播客 - Apple](https://help.apple.com/itc/podcasts_connect/#/itca5b22233a) - RSS 格式参考: https://codepen.io/jon-walstedt/pen/jsIup - 播客验证: https://podba.se/validate/?url=https://rsshub.app/ximalaya/album/299146/ -这些字段能使你的 RSS 被泛用型播客软件订阅: +这些字段能使你的 RSS 被泛用型播客软件订阅： ```js ctx.state.data = { @@ -154,7 +310,124 @@ ctx.state.data = { }; ``` -