接口背景: 希望在推送数据之前获取线上文档数据
接口意义:

  1. 自定义改动范围。
    有时候我们会希望在推送之前,获取线上文档的状态,有选择性的更新文档内容,如:接口描述,可能涉及的文字比较多的,我们希望纯线上维护即可,在代码中注释会显得代码很“肥”,类似的,还有排序,维护人等
  2. 数据分析
    我们可以需要分析文档各项指标,如文档接口个数,各分类接口个数,废弃接口比率,信息不完整接口列表,各种请求接口个数,占比等等。