api_project.js 3.3 KB

12345678910111213141516171819202122232425262728
  1. define({
  2. "name": "EIN接口文档",
  3. "version": "0.0.1",
  4. "description": "",
  5. "title": "EIN接口测试界面",
  6. "url": "http://120.132.6.151:8084/api/api",
  7. "sampleUrl": "http://120.132.6.151:8084/api/api",
  8. "header": {
  9. "title": "start",
  10. "content": "<h3>接口返回公共对象说明</h3>\n<h2>content:</h2>\n<pre><code class=\"language-javascript\">kind:内容类型:10-富文本、20-图片、30-视频\nrichTextContent:富文本内容,当kind=10时有值\nvideoUrl:视频url,当kind=30时有值\nvideoName:视频名称,当kind=30时有值\nimageList:图片列表,当kind=20时有值\n</code></pre>\n<h2>link:</h2>\n<pre><code class=\"language-javascript\">kind:10=外链、20=系统链接\nnetUrl:外链url,当kind=10时有值\nbusinessType:业务类型,当kind=20时有值,10=大片、20=秀演、30=视频、40=分享、50=动向、60=新闻\nbusinessId:业务id,当kind=20时有值\n</code></pre>\n<h3>接口返回格式</h3>\n<h2>单条数据:</h2>\n<blockquote>\n<p>服务器异常:</p>\n</blockquote>\n<pre><code class=\"language-javascript\">{ \n &quot;code&quot;:&quot;错误code&quot;,\n &quot;message&quot;:&quot;错误信息&quot;,\n &quot;data&quot;:{}\n}\n</code></pre>\n<blockquote>\n<p>失败:</p>\n</blockquote>\n<pre><code class=\"language-javascript\">{\n &quot;code&quot;:&quot;错误code&quot;,\n &quot;message&quot;:&quot;错误编码&quot;,\n &quot;data&quot;:{}\n}\n</code></pre>\n<blockquote>\n<p>成功:</p>\n</blockquote>\n<pre><code class=\"language-javascript\">{\n &quot;code&quot;:&quot;0&quot;,\n &quot;message&quot;:&quot;&quot;,\n &quot;data&quot;:{\n &quot;id&quot;:&quot;1&quot;,\n &quot;name&quot;:&quot;wb&quot;\n }\n}\n</code></pre>\n<h2>多条数据:</h2>\n<blockquote>\n<p>服务器异常:</p>\n</blockquote>\n<pre><code class=\"language-javascript\">{\n &quot;code&quot;:&quot;错误code&quot;,\n &quot;message&quot;:&quot;错误信息&quot;,\n &quot;data&quot;:{}\n}\n</code></pre>\n<blockquote>\n<p>失败:</p>\n</blockquote>\n<pre><code class=\"language-javascript\">{\n &quot;code&quot;:&quot;错误code&quot;,\n &quot;message&quot;:&quot;错误信息&quot;,\n &quot;data&quot;:{}\n}\n</code></pre>\n<blockquote>\n<p>成功:</p>\n</blockquote>\n<pre><code class=\"language-javascript\">{\n &quot;code&quot;:&quot;0&quot;,\n &quot;message&quot;:&quot;&quot;,\n &quot;data&quot;:{\n &quot;list&quot;:[\n {\n &quot;id&quot;:267,\n &quot;city&quot;:&quot;Wuhan&quot;\n },\n {\n &quot;id&quot;:266,\n &quot;city&quot;:&quot;Nanjin&quot;\n }\n ]\n }\n}\n</code></pre>\n<h3>错误码</h3>\n<table>\n<thead>\n<tr>\n<th>解释</th>\n<th>错误码</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>服务器错误</td>\n<td>error_0001</td>\n</tr>\n<tr>\n<td>参数不正确</td>\n<td>error_0002</td>\n</tr>\n<tr>\n<td>没有数据</td>\n<td>error_0003</td>\n</tr>\n</tbody>\n</table>\n"
  11. },
  12. "template": {
  13. "forceLanguage": "zh",
  14. "withCompare": true,
  15. "withGenerator": true
  16. },
  17. "jQueryAjaxSetup": {
  18. "cache": false
  19. },
  20. "defaultVersion": "0.0.0",
  21. "apidoc": "0.3.0",
  22. "generator": {
  23. "name": "apidoc",
  24. "time": "2017-05-15T09:44:52.275Z",
  25. "url": "http://apidocjs.com",
  26. "version": "0.17.5"
  27. }
  28. });