梁臣-API规约-20180706
<ul>
<li>API规约
<strong>1.API划分</strong>
<strong>前缀设置</strong></li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">前缀</th>
<th style="text-align: left;">说明</th>
<th style="text-align: left;">备注</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">/web-api</td>
<td style="text-align: left;">app用API</td>
<td style="text-align: left;">--</td>
</tr>
<tr>
<td style="text-align: left;">/open</td>
<td style="text-align: left;">开放平台API</td>
<td style="text-align: left;">大学长平台开放给其他系统的API</td>
</tr>
<tr>
<td style="text-align: left;">/[页面路径]/*</td>
<td style="text-align: left;">页面用api</td>
<td style="text-align: left;">--</td>
</tr>
<tr>
<td style="text-align: left;">/[产品缩写]/*</td>
<td style="text-align: left;">产品用api</td>
<td style="text-align: left;">--</td>
</tr>
</tbody>
</table>
<p><strong>后缀设置</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">后缀</th>
<th style="text-align: left;">说明</th>
<th style="text-align: left;">备注</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">.html</td>
<td style="text-align: left;">---</td>
<td style="text-align: left;">当前所有API都使用html做为后缀</td>
</tr>
<tr>
<td style="text-align: left;">.json</td>
<td style="text-align: left;">---</td>
<td style="text-align: left;">--</td>
</tr>
<tr>
<td style="text-align: left;">.do</td>
<td style="text-align: left;">---</td>
<td style="text-align: left;">--</td>
</tr>
<tr>
<td style="text-align: left;">.action</td>
<td style="text-align: left;">---</td>
<td style="text-align: left;">--</td>
</tr>
<tr>
<td style="text-align: left;">.form</td>
<td style="text-align: left;">---</td>
<td style="text-align: left;">--</td>
</tr>
</tbody>
</table>
<p><strong>2.全局参数</strong>
<strong>全局api需要作为自定义http请求头发送给服务器</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">字段</th>
<th style="text-align: left;">可以为空</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">--</td>
<td style="text-align: left;">--</td>
<td style="text-align: left;">--</td>
<td>--</td>
</tr>
</tbody>
</table>
<p><strong>3.返回值结构</strong></p>
<p><strong>正常情况：</strong>
{
"success": true,
"result": T.toJson()
}</p>
<p><strong>异常情况：</strong></p>
<p>{
"success": false,
"result": null,
"code": "00001",
"error": "api路径错误"
}</p>
<p><strong>4.接口参数加密/解密</strong>
无需实现</p>
<p><strong>5.其他</strong>
查询相关api，如果没有查询到结果，视为业务逻辑执行成功（返回值中的success为true），但是result字段中没有相关结果，需要调用者判断一下</p>
<p><strong>6.API Sample</strong>
调用例：用户登录</p>
<p><strong>7.API 错误码表说明</strong>
●公用错误码请查看错误码表
●各自接口个性化错误码，请查看各自API文档</p>