restfu接口文档模板

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