restfu接口文档模板

XXXX公司接口协议说明书实施日期：2017-08-16文件名称：接口协议说明书第1页，共7页文件编号：XX-PNXXXXX-RS-XXX版本号：00接口协议说明书受控状态：发放号：2017-07-13发布2017-07-13实施编制:审核:批准:姓名：部门：姓名：部门：姓名：部门：接口协议说明书实施日期：2017-08-16文件名称：接口协议说明书第2页，共7页文件编号：XX-PNXXXXX-RS-XXX版本号：00版权说明本文件中出现的任何文字叙述、文档格式、插图、照片、方法、过程等内容，除另有特别注明，版权均属XXXX公司所有，受到有关产权及版权法保护。本文件及其附录的知识产权归XXXX公司所有。如无授权，请勿复制或传播。本文件将交付XX系统开发使用，使用范围仅局限于工程。接口协议说明书实施日期：2017-08-16文件名称：接口协议说明书第3页，共7页文件编号：XX-PNXXXXX-RS-XXX版本号：00修订页版本章节名称修订内容简述修订日期00所有章节创建2017-08-16接口协议说明书实施日期：2017-08-16文件名称：接口协议说明书第4页，共7页文件编号：XX-PNXXXXX-RS-XXX版本号：00目录通信协议说明书.......................................................................................................................................................1目录.......................................................................................................................................................................41引言...................................................................................................................................................................51.1Restful介绍.......................................................................................................................................52中心服务器与播放控制器间通信协议...........................................................................................................52.1概述...................................................................................................................................................52.2用户管理...........................................................................................................................................52.2.1登录...........................................................................................................................................5接口协议说明书实施日期：2017-08-16文件名称：接口协议说明书第5页，共7页文件编号：XX-PNXXXXX-RS-XXX版本号：001引言1.1Restful介绍REpresentationalStateTransfer(REST)是一种架构原则，其中将web服务视为资源，可以由其URL唯一标识。RESTfulWeb服务的关键特点是明确使用HTTP方法来表示不同的操作的调用。REST的基本设计原则对典型CRUD操作使用HTTP协议方法：POST-创建资源GET-检索资源PUT–更新资源DELETE-删除资源.REST服务的主要优势在于：它们是跨平台(Java、.net、PHP等）高度可重用的，因为它们都依赖基本HTTP协议。它们使用基本的XML/JSON，而不是复杂的SOAPXML，使用非常方便。2中心服务器与播放控制器间通信协议2.1概述云平台中心服务器与播放控制器间的通信采用restful通信协议框架，云平台作为restful服务器，播放控制器作为restful客户端。登录2.2用户管理2.2.1登录2.2.1.1请求APIPOST/api/v1/login2.2.1.2请求参数描述NameInTypeDescriptionaccountbodystringUseraccountpasswordbodystringUserpasswordencryption2.2.1.3请求参数示例{account:admin,password:md5(admin)}接口协议说明书实施日期：2017-08-16文件名称：接口协议说明书第6页，共7页文件编号：XX-PNXXXXX-RS-XXX版本号：002.2.1.4回应状态码状态码描述200-OK成功401-Unauthorized未授权403-Forbidden当前用户无权限503-ServiceUnavailable服务不可用2.2.1.5回应参数描述NameInTypeDescriptiontokenbodystringSessiontokenexpired_inbodyint时效，单位秒idbodyint用户IDaccountbodystring账号namebodystring名称descriptionbodystring描述statusbodyint用户状态0:禁用1：启用update_timebodystring更新时间，格式:”%Y%m%d%H%M%S”functionsbodyint[]功能权限Id数组2.2.1.6回应参数示例{token:69B3E86AEB5C278B5758B6F705E041C6,expired_in:60,id:1,account:admin,name:管理员,description:,status:1,update_time:20160510121030,functions:[1,2]}