API文档导出

API文档导出说明

API文档是指导用户进行API使用的操作手册,文档以“类目”为单位编写,记录以下内容:

  • 该类目下的用户申请并得到审批授权的API名称,API基础信息,输入参数和输出参数,请求返回示例和返回结果。

  • API返回码。

为了让用户更为便捷的使用数据服务服务,用户购买API服务时,默认会为用户开通与数据服务相关的内容服务,当用户需要对已申请通过的API的文档进行本地查看时,可下载已审批通过的API文档至本地进行使用。

(1)导出的API文档,为该类目下已审批通过的API,将全部显示在"类目名.md"中;
(2)若该类目下没有审批通过的API,则无法导出该类目所包含的API文档。

API文档导出流程

步骤一:点击进入"我的API"页面,选择"API文档导出"(默认已在API市场完成申请,并已通过管理员审批)

image.png

步骤二:若类目较多,可在搜索框内输入所需的导出的API文档的API所在的类目

步骤三:点击右侧"API文档导出"按钮,即可完成该类目下所有API文档的导出

步骤四:等待API文档生成并自动下载,会在提示框内显示导出API文档的类目,以及该类目下包含API的数据量。用户可打开md文档查看内容

image.png