接口文档的认识和理解.ppt

接口文档 前言 大部分的应用都是通过网络服务器来进行数据存储的。在Android应用开发过程中经常要添加对服务器端的访问，那么要最快捷的与服务器端达到访问地址及参数的统一设置就需要一份描述清晰完整的接口文档。本节主要介绍接口文档的作用以及理解。 课程内容 接口文档 技能拓展 初识Android UI常用控件（一） UI常用控件（二） 网络数据交互 Activity及本地数据存储 目录 接口文档的组成部分 接口文档的理解 接口文档 接口文档的组成部分 接口文档作为客户端和服务器端之间的对接规范，里面包含了接口的所有内容。 1.服务器地址 大部分情况服务器端的接口都是用一个服务器地址，但也有可能有特例（比如服务器中图片资源可能存放在另一个地址上）。 接口文档 接口文档的组成部分 2.接口名称及作用 接口一般都是由客户端开发人员提出需求，然后由服务器端开发人员进行实现。接口的名称可由任一方决定，另一方遵从即可。 接口文档 接口文档的组成部分 3.接口的字段参数 表示客户端使用该接口时，需要向服务器提交哪些字段参数以及各自代表的意义。有时还会对某些字段参数有取值限制(比如下图中的nameType只能传入0或1，代表邮箱类型或手机类型)。 接口文档 接口文档的组成部分 注意：如果接口的某个字段参数可能包含中文，在使用时需要将该参数值先进行转码再提交。一般来说都是转成UTF-8格式，但是最好与服务器端确认一下。而服务器端也需要将该字段进行相同格式的解码。 接口文档 接口文档的组成部分 4.接口的返回值 这一项由客户端人员提出需求，服务器端人员实现。一份规范的接口文档至少应该包含返回值的字段名、意义以及备注说明。 接口文档 接口文档的组成部分 常见的返回值描述： 字段名：客户端通过字段名解析和获得数据; 意义：当返回字段过多时能够明确每个字段的代表含义; 备注说明：用于描述字段中的值所代表的意义; (如isauthor中的0代表普通用户，1代表作者身份) 父字段：当返回数据具有层级关系时，标注父字段可以帮助客户端更快的理解返回数据的结构。 接口文档 接口文档的组成部分 示例： 接口文档 接口文档的组成部分 根据此文档客户端人员可以得知：当需要频道类型获得类别信息时调用的接口名称为：GetCategoryByParentTypeAction，同时需要传入一个参数parentType，频道类型为小说时parentType的值传入0，漫画为1，音频为2，视频为3。 而获得服务器端的返回数据包含了result、list、cateIcon、cateName、id、parentType这几个字段。 接口文档 接口文档 总结 接口文档是客户端与服务器端用于对接的一个约定，并没有一个固定规范模板。文档里面的内容也是由双方协商拟定的，不同的开发人员提供的接口文档格式可能有很大差别。但是只要我们了解了接口文档的作用就能很快理解接口文档里的内容了。 接口文档 习题 根据提供的接口文档编写代码访问服务器，要能够正确的获得服务器的数据并将其填充到界面中的控件上。