RSS 和 JSON Feed
GET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/rss.xmlGET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/feed.json以读者理解的两种格式——RSS 2.0 和 JSON Feed 1.1——将相同的已发布条目作为可订阅的 feed 提供。两者都接受与 changelog feed 相同的 repos、category 和 tag 过滤器,并带有相同的 Cache-Control 和 ETag。两者都不分页:读者轮询的是 feed 的最新内容,因此这些接口只返回最新的条目,没有游标。
条目文本是经过净化的 HTML,在 RSS 中包裹在 CDATA 中,在 JSON Feed 中则作为 content_html 提供,开启图片后其中也会包含你的图片。条目的头图在 RSS 中是一个 media:content 元素,在 JSON Feed 中是该条目的 image。JSON Feed 还会在一个带命名空间的 _changelogapp 扩展下附带你的标签颜色,RSS 则不会,因为没有阅读器会去渲染这些颜色。
托管页面将两者都以 rel="alternate" 链接的形式对外声明,因此浏览器或阅读器落到该页面上时,无需被告知具体路径也能订阅。
markdown feed
GET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/changelog.md以纯 markdown 的形式提供相同的已发布条目,作为 text/markdown 提供。它是为非浏览器的读者而存在的:回答“这个产品最近有什么变化”的 LLM 或代理无需解析 RSS 或遍历 JSON 即可获得文本内容。它接受与 changelog feed 相同的 repos、category 和 tag 过滤器,带有相同的 Cache-Control 和 ETag,并与另外两个接口完全一样地对条件请求返回 304。
每个条目都是一个小节:标题作为标题行,之后是包含日期、分类和任何标签的单独一行,如果条目有一张来自你列表中主机的头图,接着是以 markdown 图片行呈现的头图,然后是条目文本,之后是条目的 Learn more 链接(如果有),最后是它的永久链接。文档以你的 feed 标题和描述开头,并链接回托管页面。当尚无任何内容发布时,它会用一句话说明这一点,而不是返回空的内容体,这样读者就能将其与一次失败的请求区分开来。
站点地图
GET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/sitemap.xml面向搜索引擎的、单个 changelog 的站点地图:包含 changelog 页面和每个已发布条目的永久链接,使用读者看到的地址;如果你在设置的自定义域名中配置了域名,这些地址就在你自己的域名下。条目的 lastmod 是它的发布日期,页面的 lastmod 是你最新条目的日期。它列出最新的 1000 个条目,不接受任何过滤器,带有与 feed 相同的 Cache-Control 和 ETag,并对条件请求返回 304。
搜索引擎不会自行发现这个文件,而且只有当站点地图中的页面位于提供该文件的主机上,或者该文件是为那个网站提交的时候,才会接受它。所以请在搜索控制台中,为你的 changelog 所在的域名提交这个地址。
changelog feed
你已发布的条目,按最新排序;时间戳相同时以最新的 ID 打破平局。