知乎日报 API 分析(如何规范api设计)

灰太狼 2022-06-04 05:48 250阅读 0赞

# 知乎日报 API 分析 #

Xiao Liang edited this page on 30 Sep ·  [41 revisions][]

###  Pages 2 ###

*  [Home][]
 *  [知乎日报 API 分析][API]

##### Clone this wiki locally #####

Clone in Desktop

# 声明 #

以下所有 API 均由 知乎（Zhihu.Inc） 提供，本人（Xiao Liang）采取非正常手段获取。获取与共享之行为或有侵犯知乎权益的嫌疑。若被告知需停止共享与使用，本人会及时删除此页面与整个项目。  
请您暸解相关情况，并遵守知乎协议。

# API 说明 #

*  知乎日报的消息以 JSON 格式输出
 *  网址中 `api` 后数字代表 API 版本，过高或过低均会得到错误信息
 *  较老的接口（启动界面图像获取，最新消息，过往消息）中将数字 2 替换为 1.2 获得效果相同，替换为 1.1 获得的是老版本 API 输出的 JSON 格式（替换为更低，如 1.0，或更高，如 1.3，将会获得错误消息）
 *  以下所有 API 使用的 HTTP Method 均为 `GET`
 *  所有的链接均使用 `HTTPS`

# API 分析 #

### 1. 启动界面图像获取 ###

*  URL: `https://news-at.zhihu.com/api/7/prefetch-launch-images/1080*1920`
 *  该 API 似乎已经停止使用。最新版本的 App 在启动时并无 Splash Screen，App 将直接显示日报内容或弹出广告。
 *  `prefetch-launch-images` 后为图像分辨率，接受任意的 `number*number` 格式， `number` 为任意非负整数，返回值均相同。
 *  响应实例：

{
        "creatives": [
            {
                "url": "https://pic3.zhimg.com/v2-5af460972557190bd4306ad66f360d4a.jpg",
                "start_time": 1491927091,
                "impression_tracks": [
                    "https://sugar.zhihu.com/track?vs=1&ai=3838&ut=&cg=2&ts=1491927091.68&si=52848dcc42b046bbb2d7a40921268157&lu=0&hn=ad-engine.ad-engine.7fab952b&at=impression&pf=PC&az=11&sg=4590d6230fc8f471ada5f10e6f27be94"
                ],
                "type": 0,
                "id": "3838"
            }
        ]
    }

*  分析：
    
     *  `url` : 图像的 URL
     *  `start_time` : 获取的时间(ms)

### 2. 软件版本查询 ###

*  Android: `https://news-at.zhihu.com/api/4/version/android/2.3.0`
 *  iOS: `https://news-at.zhihu.com/api/4/version/ios/2.3.0`
 *  URL 最后部分的数字代表所安装『知乎日报』的版本
 *  响应实例：
    
    软件为最新版本时
    
        {
              "status": 0,
              "latest": "2.2.0"
          }
    
    软件为较老版本时
    
        {
              "status": 1,
              "msg": "【更新内容】（后略）",
              "latest": "2.2.0"
          }
 *  分析：
    
     *  `status` : 0 代表软件为最新版本，1 代表软件需要升级
     *  `latest` : 软件最新版本的版本号（数字的第二段会比最新的版本号低 1）
     *  `msg` : 仅出现在软件需要升级的情形下，提示用户升级软件的对话框中显示的消息

### 3. 最新消息 ###

*  URL: `https://news-at.zhihu.com/api/4/news/latest`
 *  响应实例：
    
        {
              date: "20140523",
              stories: [
                  {
                      title: "中国古代家具发展到今天有两个高峰，一个两宋一个明末（多图）",
                      ga_prefix: "052321",
                      images: [
                          "http://p1.zhimg.com/45/b9/45b9f057fc1957ed2c946814342c0f02.jpg"
                      ],
                      type: 0,
                      id: 3930445
                  },
              ...
              ],
              top_stories: [
                  {
                      title: "商场和很多人家里，竹制家具越来越多（多图）",
                      image: "http://p2.zhimg.com/9a/15/9a1570bb9e5fa53ae9fb9269a56ee019.jpg",
                      ga_prefix: "052315",
                      type: 0,
                      id: 3930883
                  },
              ...
              ]
          }
 *  分析：
    
     *  `date` : 日期
     *  `stories` : 当日新闻
        
         *  `title` : 新闻标题
         *  `images` : 图像地址（官方 API 使用数组形式。目前暂未有使用多张图片的情形出现，曾见无 `images` 属性的情况，请在使用中注意 ）
         *  `ga_prefix` : 供 Google Analytics 使用
         *  `type` : 作用未知
         *  `id` : `url` 与 `share_url` 中最后的数字（应为内容的 id）
         *  `multipic` : 消息是否包含多张图片（仅出现在包含多图的新闻中）
     *  `top_stories` : 界面顶部 ViewPager 滚动显示的显示内容（子项格式同上）（请注意区分此处的 `image` 属性与 `stories` 中的 `images` 属性）

### 4. 消息内容获取与离线下载 ###

*  URL: `https://news-at.zhihu.com/api/4/news/3892357`
 *  使用在 `最新消息` 中获得的 `id`，拼接在 `https://news-at.zhihu.com/api/4/news/` 后，得到对应消息 JSON 格式的内容
 *  响应实例：
    
        {
              body: "<div class="main-wrap content-wrap">...</div>",
              image_source: "Yestone.com 版权图片库",
              title: "深夜惊奇 · 朋友圈错觉",
              image: "http://pic3.zhimg.com/2d41a1d1ebf37fb699795e78db76b5c2.jpg",
              share_url: "http://daily.zhihu.com/story/4772126",
              js: [ ],
              recommenders": [
                  { "avatar": "http://pic2.zhimg.com/fcb7039c1_m.jpg" },
                  { "avatar": "http://pic1.zhimg.com/29191527c_m.jpg" },
                  { "avatar": "http://pic4.zhimg.com/e6637a38d22475432c76e6c9e46336fb_m.jpg" },
                  { "avatar": "http://pic1.zhimg.com/bd751e76463e94aa10c7ed2529738314_m.jpg" },
                  { "avatar": "http://pic1.zhimg.com/4766e0648_m.jpg" }
              ],
              ga_prefix: "050615",
              section": {
                  "thumbnail": "http://pic4.zhimg.com/6a1ddebda9e8899811c4c169b92c35b3.jpg",
                  "id": 1,
                  "name": "深夜惊奇"
              },
              type: 0,
              id: 4772126,
              css: [
                  "http://news.at.zhihu.com/css/news_qa.auto.css?v=1edab"
              ]
          }
 *  分析：
    
     *  `body` : HTML 格式的新闻
     *  `image-source` : 图片的内容提供方。为了避免被起诉非法使用图片，在显示图片时最好附上其版权信息。
     *  `title` : 新闻标题
     *  `image` : 获得的图片同 `最新消息` 获得的图片分辨率不同。这里获得的是在文章浏览界面中使用的大图。
     *  `share_url` : 供在线查看内容与分享至 SNS 用的 URL
     *  `js` : 供手机端的 WebView(UIWebView) 使用
     *  `recommenders` : 这篇文章的推荐者
     *  `ga_prefix` : 供 Google Analytics 使用
     *  `section` : 栏目的信息
        
         *  `thumbnail` : 栏目的缩略图
         *  `id` : 该栏目的 `id`
         *  `name` : 该栏目的名称
     *  `type` : 新闻的类型
     *  `id` : 新闻的 id
     *  `css` : 供手机端的 WebView(UIWebView) 使用
        
         *  可知，知乎日报的文章浏览界面利用 WebView(UIWebView) 实现
 *  特别注意  
    在较为特殊的情况下，知乎日报可能将某个主题日报的站外文章推送至知乎日报首页。  
    响应实例：
    
        {
              "theme_name": "电影日报",
              "title": "五分钟读懂明星的花样昵称：一美、法鲨……",
              "share_url": "http://daily.zhihu.com/story/3942319",
              "js": [],
              "ga_prefix": "052921",
              "editor_name": "邹波",
              "theme_id": 3,
              "type": 1,
              "id": 3942319,
              "css": [
                  "http://news.at.zhihu.com/css/news_qa.6.css?v=b390f"
              ]
          }
    
    此时返回的 JSON 数据缺少 `body`，`image-source`，`image`，`js` 属性。多出 `theme_name`，`editor_name`，`theme_id` 三个属性。`type` 由 `0` 变为 `1`。

### 5. 过往消息 ###

*  URL: `https://news-at.zhihu.com/api/4/news/before/20131119`
 *  若果需要查询 11 月 18 日的消息，`before` 后的数字应为 `20131119`
 *  知乎日报的生日为 2013 年 5 月 19 日，若 `before` 后数字小于 `20130520` ，只会接收到空消息
 *  输入的今日之后的日期仍然获得今日内容，但是格式不同于最新消息的 JSON 格式
 *  响应实例：
    
        {
              date: "20131118",
              stories: [
                  {
                      title: "深夜食堂 · 我的张曼妮",
                      ga_prefix: "111822",
                      images: [
                          "http://p4.zhimg.com/7b/c8/7bc8ef5947b069513c51e4b9521b5c82.jpg"
                      ],
                      type: 0,
                      id: 1747159
                  },
              ...
              ]
          }
 *  格式与前同，恕不再赘述

### 6. 新闻额外信息 ###

*  URL: `https://news-at.zhihu.com/api/4/story-extra/#{id}`
 *  输入新闻的ID，获取对应新闻的额外信息，如评论数量，所获的『赞』的数量。
 *  响应实例：
    
        {
              "long_comments": 0,
              "popularity": 161,
              "short_comments": 19,
              "comments": 19,
          }
 *  分析：
    
     *  `long_comments` : 长评论总数
     *  `popularity` : 点赞总数
     *  `short_comments` : 短评论总数
     *  `comments` : 评论总数

### 7. 新闻对应长评论查看 ###

*  URL: `https://news-at.zhihu.com/api/4/story/8997528/long-comments`
 *  使用在 `最新消息` 中获得的 `id`，在 `https://news-at.zhihu.com/api/4/story/#{id}/long-comments` 中将 `id` 替换为对应的 `id`，得到长评论 JSON 格式的内容
 *  响应实例：
    
        {
              "comments": [
                  {
                       "author":"巨型黑娃儿",
                       "content":"也不算逻辑问题。其实小时候刚刚听说这个玩意的时候我也奇...",
                       "avatar":"http://pic3.zhimg.com/4131a3385c748c9e2d02ab80e29a0c52_im.jpg",
                       "time":1479706360,
                       "reply_to":{
                                   "content":"第二个机灵抖的还是有逻辑问题，不该说忘了，应该说没喝过啊我也不知道",
                                   "status":0,
                                   "id":27275308,
                                   "author":"2233155495"
                                   },
                       "id":27276057,
                       "likes":2
                  },
                  ...
              ]
          }
 *  分析：
    
     *  `comments` : 长评论列表，形式为数组（请注意，其长度可能为 0）
        
         *  `author` : 评论作者
         *  `content` : 评论的内容
         *  `avatar` : 用户头像图片的地址
         *  `id` : 评论者的唯一标识符
         *  `likes` : 评论所获『赞』的数量
         *  `time` : 评论时间
         *  `reply_to` : 所回复的消息
            
             *  `content` : 原消息的内容
             *  `status` : 消息状态，0为正常，非0为已被删除
             *  `id` : 被回复者的唯一标识符
             *  `author` : 被回复者
             *  `err_msg`: 错误消息，仅当`status`非0时出现

### 8. 新闻对应短评论查看 ###

*  URL: `https://news-at.zhihu.com/api/4/story/4232852/short-comments`
 *  使用在 `最新消息` 中获得的 `id`，在 `https://news-at.zhihu.com/api/4/story/#{id}/short-comments` 中将 `id` 替换为对应的 `id`，得到短评论 JSON 格式的内容
 *  响应实例：
    
        {
              "comments": [
                  {
                      "author": "Xiaole说",
                      "id": 545721,
                      "content": "就吃了个花生米，呵呵",
                      "likes": 0,
                      "time": 1413600071,
                      "avatar": "http://pic1.zhimg.com/c41f035ab_im.jpg"
                  },
                  ...
              ]
          }
 *  格式与前同，恕不再赘述

### 9. 主题日报列表查看 ###

*  URL: `https://news-at.zhihu.com/api/4/themes`
 *  响应实例：
    
        {
              "limit": 1000,
              "subscribed": [ ],
              "others": [
                  {
                      "color": 8307764,
                      "thumbnail": "http://pic4.zhimg.com/2c38a96e84b5cc8331a901920a87ea71.jpg",
                      "description": "内容由知乎用户推荐，海纳主题百万，趣味上天入地",
                      "id": 12,
                      "name": "用户推荐日报"
                  },
                  ...
              ]
          }
    
     *  分析：
        
         *  `limit` : 返回数目之限制（仅为猜测）
         *  `subscribed` : 已订阅条目
         *  `others` : 其他条目
            
             *  `color` : 颜色，作用未知
             *  `thumbnail` : 供显示的图片地址
             *  `description` : 主题日报的介绍
             *  `id` : 该主题日报的编号
             *  `name` : 供显示的主题日报名称

### 10. 主题日报内容查看 ###

*  URL: `https://news-at.zhihu.com/api/4/theme/11`
 *  使用在 `主题日报列表查看` 中获得需要查看的主题日报的 `id`，拼接在 `https://news-at.zhihu.com/api/4/theme/` 后，得到对应主题日报 JSON 格式的内容
 *  响应实例：
    
        {
              stories: [
                  {
                      images: [
                          "http://pic1.zhimg.com/84dadf360399e0de406c133153fc4ab8_t.jpg"
                      ],
                      type: 0,
                      id: 4239728,
                      title: "前苏联监狱纹身百科图鉴"
                  },
                  ...
              ],
              description: "为你发现最有趣的新鲜事，建议在 WiFi 下查看",
              background: "http://pic1.zhimg.com/a5128188ed788005ad50840a42079c41.jpg",
              color: 8307764,
              name: "不许无聊",
              image: "http://pic3.zhimg.com/da1fcaf6a02d1223d130d5b106e828b9.jpg",
              editors: [
                  {
                      url: "http://www.zhihu.com/people/wezeit",
                      bio: "微在 Wezeit 主编",
                      id: 70,
                      avatar: "http://pic4.zhimg.com/068311926_m.jpg",
                      name: "益康糯米"
                  },
                  ...
              ],
              image_source: ""
          }
    
     *  分析：
        
         *  `stories` : 该主题日报中的文章列表
            
             *  `images` : 图像地址（其类型为数组。请留意在代码中处理无该属性与数组长度为 0 的情况）
             *  `type` : 类型，作用未知
             *  `title` : 消息的标题
         *  `description` : 该主题日报的介绍
         *  `background` : 该主题日报的背景图片（大图）
         *  `color` : 颜色，作用未知
         *  `name` : 该主题日报的名称
         *  `image` : 背景图片的小图版本
         *  `editors` : 该主题日报的编辑（『用户推荐日报』中此项的指是一个空数组，在 App 中的主编栏显示为『许多人』，点击后访问该主题日报的介绍页面，请留意）
            
             *  `url` : 主编的知乎用户主页
             *  `bio` : 主编的个人简介
             *  `id` : 数据库中的唯一表示符
             *  `avatar` : 主编的头像
             *  `name` : 主编的姓名
         *  `image_source` : 图像的版权信息

### 11. 热门消息 ###

*  请注意！ 此 API 仍可访问，但是其内容未出现在最新的『知乎日报』 App 中。
 *  URL: `https://news-at.zhihu.com/api/3/news/hot`
 *  响应实例：
    
        {
              recent: [
                  {
                      news_id: 3748552,
                      url: "http://daily.zhihu.com/api/2/news/3748552",
                      thumbnail: "http://p3.zhimg.com/67/6a/676a8337efec71a100eea6130482091b.jpg",
                      title: "长得漂亮能力出众性格单纯的姑娘为什么会没有男朋友？"
                  },
              ...
              ]
          }
 *  大体同前面介绍的 API 类似，唯一需要注意的是：欲获得图片地址，不再使用 `image` 而是 `thumbnail` 属性
 *  `url` 属性可直接使用。请注意，`url` 中的 `api` 属性为 2，是较老版本。

### 12. 软件推广 ###

*  请注意！ 此 API 已无法访问，但是其内容曾出现于『知乎日报』 App 中。
 *  Android: `http://news-at.zhihu.com/api/3/promotion/android`
 *  iOS: `http://news-at.zhihu.com/api/3/promotion/ios`

### 13. 栏目总览 ###

*  请注意！ 此 API 仍可访问，但是其内容未出现在最新的『知乎日报』 App 中。
 *  URL: `http://news-at.zhihu.com/api/3/sections`
 *  响应实例：
    
        {
              data: [
                  {
                      id: 1,
                      thumbnail: "http://p2.zhimg.com/10/b8/10b8193dd6a3404d31b2c50e1e232c87.jpg",
                      name: "深夜食堂",
                      description: "睡前宵夜，用别人的故事下酒"
                  },
              ...
              ]
          }
 *  同样，注意使用 `thumbnail` 获取图像的地址

### 14. 栏目具体消息查看 ###

*  请注意！ 此 API 仍可访问，但是其内容未出现在最新的『知乎日报』 App 中。
 *  URL: `http://news-at.zhihu.com/api/3/section/1`
 *  URL 最后的数字见『栏目总览』中相应栏目的 `id` 属性
 *  响应实例：
    
        {
              news: [
                  {
                      date: "20140522",
                      display_date: "5 月 22 日"
                  },
              ...
              ],
              name: "深夜食堂",
              timestamp: 1398780001
          }
 *  往前：`http://news-at.zhihu.com/api/3/section/1/before/1398780001`
    
     *  在 URL 最后加上一个时间戳，时间戳详见 JSON 数据末端的 `timestamp` 属性

### 15. 查看新闻的推荐者 ###

*  URL: `https://news-at.zhihu.com/api/4/story/#{id}/recommenders`
 *  将新闻id填入到\#\{id\}的位置， 如 `https://news-at.zhihu.com/api/4/story/7101963/recommenders`
 *  响应实例
    
        {
              "items": [],
          	"editors": [{
          		"bio": "树上的女爵",
          		"title": "主编",
          		"id": 79,
          		"avatar": "http:\/\/pic1.zhimg.com\/0a6456810_m.jpg",
          		"name": "刘柯"
          	}],
          	"item_count": 1
          }

### 16. 获取某个专栏之前的新闻 ###

*  URL: `https://news-at.zhihu.com/api/4/section/#{section id}/before/#{timestamp}`
 *  将专栏id填入到 \#\{section id\}, 将时间戳填入到\#\{timestamp\}，如 `https://news-at.zhihu.com/api/4/section/34/before/1465772400`
 *  注：新闻id要是属于该专栏，否则，返回结果为空
 *  响应实例：
    
        {
              "stories": [
                  {
                      "images": [
                          "http://pic2.zhimg.com/27f3d8f4c1e0000d04ee446a2f020cf1_t.jpg"
                       ],
                      "type": 2,
                      "id": 7119477,
                      "title": "9 张本周最热节操图，诺一就是人生赢家本人"
                  }, ...
              ]
          }

### 17. 查看 Editor 的主页 ###

*  iOS: `https://news-at.zhihu.com/api/4/editor/#{id}/profile-page/ios`
 *  Android: `https://news-at.zhihu.com/api/4/editor/#{id}/profile-page/android`
 *  如 [https://news-at.zhihu.com/api/4/editor/79/profile-page/ios][https_news-at.zhihu.com_api_4_editor_79_profile-page_ios]

[41 revisions]: https://github.com/izzyleung/ZhihuDailyPurify/wiki/%E7%9F%A5%E4%B9%8E%E6%97%A5%E6%8A%A5-API-%E5%88%86%E6%9E%90/_history
[Home]: https://github.com/izzyleung/ZhihuDailyPurify/wiki
[API]: https://github.com/izzyleung/ZhihuDailyPurify/wiki/%E7%9F%A5%E4%B9%8E%E6%97%A5%E6%8A%A5-API-%E5%88%86%E6%9E%90
[https_news-at.zhihu.com_api_4_editor_79_profile-page_ios]: https://news-at.zhihu.com/api/4/editor/79/profile-page/ios