[规范]

[参数规范]

  1. 参数前带* 表示必填
  2. 参数命名采用小写加下划线形式
  3. 请求每个接口时,在header里带上XX-Token(用户 token),XX-Device-Type(类型:mobile,android,iphone,ipad,web,pc,mac,wxapp)，XX-Api-Version(比如1.0.0)，XX-Wxapp-AppId(小程序 AppId)

[返回结果]

  1. 参数命名采用小写加下划线形式
  2. 默认为json 格式,如有变动会在返回文档里说明格式
  3. 返回结果中的data不能是数组，必须是对象
  4. 所有远程资源文件路径返回可访问 url
  5. 添加数据后非特殊情况，都尽量返回添加数据主键

[url规范]

尽量按restful规范来，尽量用名词;

注意 api url 里的参数写法，比如portal/articles/:id 中:id只是一个占位符，你使用此 api 时应该换成你的真实参数，如portal/articles/1

[控制器名]

涉及到内容的，尽量使用复数形式，如FavoritesController

[文件路径]

  1. API输出结果中的图片链接转化为可访问链接
  2. API输出结果中文件链接为可访问链接

[Apache 获取不到 Authorization 头信息]

修改.htaccess文件，添加如下信息：RewriteRule .\* - \[env=HTTP\_AUTHORIZATION:%{HTTP:Authorization},last\]