聚合API文档阅读帮助

聚合API文档阅读帮助

该文基于聚合云数据开放平台的API文档，目的使得开发者能够方便的快速了解我们这个API文档的结构，从而能够经行高效的开发。

该API文档总共有6个大类：国外API、国内API、聚合数据API、聚合云数据平台使用教程、android系统教程、android开发教程。看名字基本也知道个大概了，这里我们着重介绍下几个API文档的阅读。关于教程，里面介绍了一些基本的android开发文档、加密解密技术，聚合数据平台的调用等等。有兴趣的读者请参考里面详细的内容。

国外API、国内API里面都是些国内外开放的API，我们在这里做了个收集和整理的工作，便于开发者找到他理想中的数据，从而经行他的开发工作。聚合数据API，我们提供了

包括LBS、资讯、交通、金融、日常生活等等的千万量级数据，供开发者选择。后续我们将会同数据商合作，持续不断地壮大我们的数据服务，供开发者使用。下面我们来介绍下，如何阅读这个API文档。

第一步：选择一个具体的API。下图我们选择了国外——旅游——CleartripAPI

第二步：当我们选定一个具体的API的时候，在下方会出现如下图的包括数据结构列表和API列表的一个展示区。有两个数据结构代表该分类下有两个API。

第三步：点击进入一个数据结构，这里我们点击ClearTrip Flights API。右方出现一个如下图的展示。这里包括所属类目、简要描述、属性三个大类。见名知意，属性里面包括类别（该API所属的类别，譬如旅游）、格式（指该API支持的数据返回格式，有XML、JSON等）、API主页（指这个API的来源，因为像国内外的API都是经过我们整理的第三方API，在这里我们提供了这个API的来源，供开发者查看，方便开发者透彻的理解该API）

第四步：点击进入一个API列表（这列表下的API都是按照功能划分的，目的使得开发者清晰地了解该API所具有的功能），这里我们点击ClearTrip Flights API_1(航班搜索)。右侧出现具体的API说明，结构包括：如遇N/A，则代表该项为空

1、 API用户授权类型（聚合云数据平台下的数据需要聚合授权请参考聚合云数据平台使用教程，国内外的API根据各个API的要求不同确定是否需要授权）。

2、简要描述。该功能的简要描述。

3、系统级参数（包括基本URL和请求方法）。

4、应用级输入参数（一些所需参数的展示及说明介绍）。

5、请求及请求示例。这两个的区别在于一个是链接式的请求，一个是代码块式的请求。两个只能有一个存在。

示例一：

示例二：国外——实用工具——USA Weather Forecast_GetWeatherByPlaceName

6、返回结果及返回示例。这两者的区别在于一个是链接式的、一个是代码块式的。两个只能有一个存在。

示例一：

示例二：国外——实用工具——USA Weather Forecast_GetWeatherByPlaceName

7、错误码。一些错误信息代码的展示。

8、 FAQ（常见问题）。

国外——房地产——Zillow API

有问题请发邮件给我们或者联系客服，谢谢合作！

转载于:https://www.cnblogs.com/le7mo27/archive/2011/04/01/2001816.html

聚合API文档阅读帮助相关推荐

ExtJS4 API文档阅读（四）——Data
2019独角兽企业重金招聘Python工程师标准>>> ExtJS4 API文档阅读(四)--Data 数据 Data包负责加载和保存你应用程序中的所有数据,由41个类构成,其中有三 ...
关于knife4j工具聚合api文档的使用
关于knife4j工具聚合api文档的使用 1 knife4j工具的介绍简单案例 1 导入Knife4j依赖 2 添加配置文件 3 添加控制器 4 查看文档 2 knife4j工具的使用聚合微服务 ...
微服务如何聚合 API 文档？这波操作也太秀了
今天这篇文章介绍一下微服务如何聚合Swagger实现接口文档管理. 文章目录如下: 为什么需要聚合? 微服务模块众多,如果不聚合文档,则访问每个服务的API文档都需要单独访问一个Swagger UI界 ...
14-网关实战：网关层整合 Swagger 聚合API文档
上节课介绍了网关层的认证鉴权,今天这节介绍一下网关层如何聚合API接口文文档. 为什么需要聚合API接口文档? 大型微服务系统模块众多,木谷博客系统就有9个,如果这些服务的接口地址没有一个统一,那么客 ...
Django QuerySet API 文档阅读（3）：QuerySet定义（一）
原文地址:QuerySet API reference | Django documentation | Django QuerySet有两个属性,ordered和db: ordered: ...
聚合微服务中的 Swagger API 文档
没有做 API 文档聚合,访问每个服务的 API 文档都需要访问单独的 swagger-ui.html 页面,既然我们使用了微服务,就应该有统一的 API 文档入口,而 knife4j 有这方面的支持 ...
Zeal —— API文档离线阅读器
背景在软件开发的过程中,常常需要查阅多个API文档,但网络环境等因素常常导致在线文档查看用户体验并不佳.为此,介绍一款离线的API文档阅读器,Zeal.Zeal中自配了多种API文档可供查阅,如El ...
SpringCloud微服务项目的api文档聚合
目录原理简介在网关中配置好路由 Spring Cloud Gatway + Springfox 第一步.在各项目里配置Springfox 第二步.在网关中编写api文档资源路径注意 Spring ...
什么是API？ [如何编写和阅读API文档]
随着API在互联网时代中变得越来越普遍,不仅是编程人员会用到,现在也会要求产品经理或互联网运营会调试和对接API.看这篇文章的你可能会使用或开发API,或者两者兼而有之. 因此,对你来说,不仅要了解如 ...

聚合API文档阅读帮助

聚合API文档阅读帮助相关推荐

最新文章

热门文章