如何合理设计API接口？

本规范仅适用于由服务器端发起调用请求、POST提交数据以及GET请求文本数据结果的API，统一采用UTF-8编码规则，采用JSON格式响应。

URL定义
API 服务接口应提供REST风格的HTTP(HTTPS) 接口：
{protocol}://{domain}:{port}/{ app}/{controller}/{action}?{query}
变量 含义 示例
protocol 接口协议 HTTP、HTTPS
domain 网关ip地址或者网关域名 api.xxx.com
port 网关端口号 80、8080
app 应用名 SMSManage、UserManage等
controller 控制器名 UserInfo、DepartmentInfo
action 操作方法 CREATE、SELECT、UPDATE、DELETE等
query由系统级参数部分和具体API调用参数部分组成，以key1=value1&key2=value2&…表示。
对于采用POST请求的Open API，query部分则是在POST请求体里。

请求头格式
名称 必填 描述
Content-Type 是 application/x-www-form-urlencoded;charset=utf-8；
或application/json;charset=utf-8；

系统级请求参数
名称 必填 描述
appid 是 请求账号
timestamp 是 Unix时间戳，即从1970年1月1日0时0分0秒开始所经过的秒数（安全验证有效期60秒，防replay攻击）
sign_type 否 安全验证方式，默认为MD5。
sign 是 加密字符。

应用