21 lines
2.4 KiB
JSON
21 lines
2.4 KiB
JSON
{
|
||
"name": "Shop电商App",
|
||
"version": "1.2.0",
|
||
"description": "Shop电商app后端接口",
|
||
"title": "电商App",
|
||
"url": "http://127.0.0.1:9090",
|
||
"header": {
|
||
"title": "使用注意事项",
|
||
"content": "<hr>\n<h2>【注意】使用注意事项</h2>\n<p>1：前端接口使用<code>公钥</code>进行数据的加解密操作，并将数据放到自定义请求头<code>data</code>中进行传递给后端，主要前端加解密逻辑在<code>api/index.js</code>的拦截器中实现</p>\n<p>2：用户登录注册的时候发送接口，请求头中不需要<code>jwt</code>的<code>token</code>字段。用户登录成功后，登录接口会返回<code>token</code>参数。请前端自己使用<code>localStorage.setItem</code>\n方法进行本地保存<code>token</code>字段。后端的所有接口在数据请求的时候需要在请求头携带<code>token</code>字段通过身份验证。</p>\n<p>3：有些接口没有参数的话，需要在调用<code>xxxService</code>的时候传入一个空的对象。例如请求首页接口</p>\n<pre class=\"prettyprint\">await this.$http.homeService.getHomeData({}); # getHomeData方法接口空对象: {}\n</code></pre>\n<p>4：接口返回的数据格式如下：</p>\n<pre class=\"prettyprint\">{\n \"status\" : 200,\n \"message\" : \"请求成功\"\n \"result\" : \"asjXzXxmnSp8TZGWiTSlJF8Gb...5LhYoHs86SEI2LBXrTZ9e/a4frZOWHZ\"\n}\n</code></pre>\n<ul>\n<li>\n<p>4.1：status：主要作用标志请求是否成功，<code>200</code>表示接口请求成功无错误，<code>404</code>表示接口请求出现错误</p>\n</li>\n<li>\n<p>4.2：message：当 <code>status</code> 为 <code>200</code> 的时候值为：<code>请求成功</code>，当 <code>status</code> 为 <code>404</code> 的时候 <code>message</code>数值为具体的接口错误信息，前端只需要在全局ajax拦截器中<code>Toast</code>弹出<code>message</code>的错误信息即可</p>\n</li>\n<li>\n<p>4.3：result: 请求的所有数据都会在本字段中，本字段的数据会使用私钥进行加密，需要前端公钥解密数据后使用</p>\n</li>\n</ul>\n<p>5：Ajax的请求方式一律使用<code>POST</code>接口，注意是<code>POST</code>！！！</p>\n"
|
||
},
|
||
"sampleUrl": false,
|
||
"defaultVersion": "0.0.0",
|
||
"apidoc": "0.3.0",
|
||
"generator": {
|
||
"name": "apidoc",
|
||
"time": "2021-01-16T05:23:27.650Z",
|
||
"url": "https://apidocjs.com",
|
||
"version": "0.26.0"
|
||
}
|
||
}
|