Skip to content

Commit

Permalink
🎨 更新dooring api文档,添加登录码加密和生成文档
Browse files Browse the repository at this point in the history
  • Loading branch information
AleryXu committed May 20, 2021
1 parent 9fde4bc commit 8beefab
Show file tree
Hide file tree
Showing 47 changed files with 431 additions and 247 deletions.
4 changes: 2 additions & 2 deletions doc-dist/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@

<meta name="description" content="">

<link rel="preload" href="/doc/assets/css/0.styles.690c58c3.css" as="style"><link rel="preload" href="/doc/assets/js/app.b8bba05a.js" as="script"><link rel="preload" href="/doc/assets/js/19.67f92c26.js" as="script"><link rel="prefetch" href="/doc/assets/js/10.2d5d3aaa.js"><link rel="prefetch" href="/doc/assets/js/11.d3f84a40.js"><link rel="prefetch" href="/doc/assets/js/12.d4cc4a96.js"><link rel="prefetch" href="/doc/assets/js/13.96be485c.js"><link rel="prefetch" href="/doc/assets/js/14.6f2488ca.js"><link rel="prefetch" href="/doc/assets/js/15.aec16679.js"><link rel="prefetch" href="/doc/assets/js/16.c8d40261.js"><link rel="prefetch" href="/doc/assets/js/17.84ee6300.js"><link rel="prefetch" href="/doc/assets/js/18.81ac15ea.js"><link rel="prefetch" href="/doc/assets/js/2.a5de04a4.js"><link rel="prefetch" href="/doc/assets/js/20.f0a28bd8.js"><link rel="prefetch" href="/doc/assets/js/21.951176bf.js"><link rel="prefetch" href="/doc/assets/js/22.eb3fcb45.js"><link rel="prefetch" href="/doc/assets/js/23.6a4f2d96.js"><link rel="prefetch" href="/doc/assets/js/24.daed6430.js"><link rel="prefetch" href="/doc/assets/js/25.51e83a6e.js"><link rel="prefetch" href="/doc/assets/js/26.e6aa3510.js"><link rel="prefetch" href="/doc/assets/js/27.5080a3bf.js"><link rel="prefetch" href="/doc/assets/js/28.55620880.js"><link rel="prefetch" href="/doc/assets/js/29.e89094bb.js"><link rel="prefetch" href="/doc/assets/js/3.ececc857.js"><link rel="prefetch" href="/doc/assets/js/30.bf067e11.js"><link rel="prefetch" href="/doc/assets/js/31.29d66811.js"><link rel="prefetch" href="/doc/assets/js/4.1eeab90b.js"><link rel="prefetch" href="/doc/assets/js/5.315fb3a4.js"><link rel="prefetch" href="/doc/assets/js/6.f057afa6.js"><link rel="prefetch" href="/doc/assets/js/7.078f0030.js"><link rel="prefetch" href="/doc/assets/js/8.63e7a89b.js"><link rel="prefetch" href="/doc/assets/js/9.5e6217e4.js">
<link rel="preload" href="/doc/assets/css/0.styles.690c58c3.css" as="style"><link rel="preload" href="/doc/assets/js/app.86394b57.js" as="script"><link rel="preload" href="/doc/assets/js/19.67f92c26.js" as="script"><link rel="prefetch" href="/doc/assets/js/10.2d5d3aaa.js"><link rel="prefetch" href="/doc/assets/js/11.df257dc3.js"><link rel="prefetch" href="/doc/assets/js/12.f89f1db1.js"><link rel="prefetch" href="/doc/assets/js/13.cf14fabe.js"><link rel="prefetch" href="/doc/assets/js/14.0938030a.js"><link rel="prefetch" href="/doc/assets/js/15.8ae75417.js"><link rel="prefetch" href="/doc/assets/js/16.ce961f82.js"><link rel="prefetch" href="/doc/assets/js/17.47167e97.js"><link rel="prefetch" href="/doc/assets/js/18.81ac15ea.js"><link rel="prefetch" href="/doc/assets/js/2.a5de04a4.js"><link rel="prefetch" href="/doc/assets/js/20.59b1f4bf.js"><link rel="prefetch" href="/doc/assets/js/21.1434ff6f.js"><link rel="prefetch" href="/doc/assets/js/22.a7421118.js"><link rel="prefetch" href="/doc/assets/js/23.61d86371.js"><link rel="prefetch" href="/doc/assets/js/24.04e2a2e3.js"><link rel="prefetch" href="/doc/assets/js/25.40d3ee9b.js"><link rel="prefetch" href="/doc/assets/js/26.f579aed8.js"><link rel="prefetch" href="/doc/assets/js/27.fa94fd1c.js"><link rel="prefetch" href="/doc/assets/js/28.f3f980e4.js"><link rel="prefetch" href="/doc/assets/js/29.e89094bb.js"><link rel="prefetch" href="/doc/assets/js/3.ececc857.js"><link rel="prefetch" href="/doc/assets/js/30.0b84ff01.js"><link rel="prefetch" href="/doc/assets/js/31.29d66811.js"><link rel="prefetch" href="/doc/assets/js/4.1eeab90b.js"><link rel="prefetch" href="/doc/assets/js/5.315fb3a4.js"><link rel="prefetch" href="/doc/assets/js/6.f057afa6.js"><link rel="prefetch" href="/doc/assets/js/7.4f98f3a5.js"><link rel="prefetch" href="/doc/assets/js/8.63e7a89b.js"><link rel="prefetch" href="/doc/assets/js/9.b96234f5.js">
<link rel="stylesheet" href="/doc/assets/css/0.styles.690c58c3.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><div class="theme-default-content"><h1>404</h1> <blockquote>Looks like we've got some broken links.</blockquote> <a href="/doc/" class="router-link-active">
Take me home.
</a></div></div><div class="global-ui"></div></div>
<script src="/doc/assets/js/app.b8bba05a.js" defer></script><script src="/doc/assets/js/19.67f92c26.js" defer></script>
<script src="/doc/assets/js/app.86394b57.js" defer></script><script src="/doc/assets/js/19.67f92c26.js" defer></script>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
360: function(t, _, v) {
t.exports = v.p + 'assets/img/deploy.d1b1d698.png';
},
389: function(t, _, v) {
391: function(t, _, v) {
'use strict';
v.r(_);
var a = v(42),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
361: function(t, v, _) {
t.exports = _.p + 'assets/img/v6.deploy.43cbe0de.png';
},
392: function(t, v, _) {
393: function(t, v, _) {
'use strict';
_.r(v);
var e = _(42),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[13],
{
362: function(s, a, t) {
370: function(s, a, t) {
s.exports = t.p + 'assets/img/down.75812dab.png';
},
395: function(s, a, t) {
406: function(s, a, t) {
'use strict';
t.r(a);
var n = t(42),
Expand All @@ -24,7 +24,7 @@
s._v(
'目前Dooring已支持下载源码功能, 我们可以使用编辑器页面头部的下载按钮来实现下载用户搭建的H5源码.\n',
),
n('img', { attrs: { src: t(362), alt: 'foo' } }),
n('img', { attrs: { src: t(370), alt: 'foo' } }),
]),
s._v(' '),
n('p', [
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[14],
{
363: function(t, e, s) {
362: function(t, e, s) {
t.exports = s.p + 'assets/img/preview-machine.895a0711.png';
},
398: function(t, e, s) {
Expand All @@ -22,7 +22,7 @@
t._v(' '),
a('p', [t._v('真机预览和网页预览的流程类似,工作流程如下:')]),
t._v(' '),
a('img', { attrs: { src: s(363), alt: 'foo' } }),
a('img', { attrs: { src: s(362), alt: 'foo' } }),
t._v(' '),
a('p', [t._v('由于不同机型预览的效果有些许不同,最终效果以实际看到的为主。')]),
]);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[15],
{
368: function(t, s, e) {
365: function(t, s, e) {
t.exports = e.p + 'assets/img/screenshot.daeecedd.png';
},
404: function(t, s, e) {
402: function(t, s, e) {
'use strict';
e.r(s);
var a = e(42),
Expand All @@ -27,7 +27,7 @@
),
]),
this._v(' '),
s('img', { attrs: { src: e(368), alt: 'foo' } }),
s('img', { attrs: { src: e(365), alt: 'foo' } }),
]);
},
[],
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[16],
{
369: function(t, s, e) {
368: function(t, s, e) {
t.exports = e.p + 'assets/img/framework.1c9c696b.png';
},
405: function(t, s, e) {
404: function(t, s, e) {
'use strict';
e.r(s);
var n = e(42),
Expand All @@ -14,7 +14,7 @@
var t = this.$createElement,
s = this._self._c || t;
return s('ContentSlotsDistributor', { attrs: { 'slot-key': this.$parent.slotKey } }, [
s('img', { attrs: { src: e(369), alt: 'foo' } }),
s('img', { attrs: { src: e(368), alt: 'foo' } }),
this._v(' '),
s('p', [this._v('注:灰色部分还未实现,正在更新中...')]),
]);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[17],
{
370: function(t, a, r) {
369: function(t, a, r) {
t.exports = r.p + 'assets/img/home.f76105db.png';
},
406: function(t, a, r) {
405: function(t, a, r) {
'use strict';
r.r(a);
var e = r(42),
Expand Down Expand Up @@ -100,7 +100,7 @@
t._v('2.其次本地启动 h5_plus,启动完毕在浏览器打开对应的启动地址即可查看,如下:'),
]),
t._v(' '),
e('img', { attrs: { src: r(370), alt: 'foo' } }),
e('img', { attrs: { src: r(369), alt: 'foo' } }),
]);
},
[],
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[20],
{
386: function(t, e, n) {
385: function(t, e, n) {
'use strict';
n.r(e);
var s = n(42),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[21],
{
390: function(t, e, n) {
387: function(t, e, n) {
'use strict';
n.r(e);
var s = n(42),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[22],
{
385: function(t, s, a) {
384: function(t, s, a) {
'use strict';
a.r(s);
var n = a(42),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[23],
{
387: function(t, s, a) {
389: function(t, s, a) {
'use strict';
a.r(s);
var n = a(42),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[24],
{
391: function(t, s, a) {
390: function(t, s, a) {
'use strict';
a.r(s);
var n = a(42),
Expand Down Expand Up @@ -416,6 +416,115 @@
]),
]),
]),
a('h3', { attrs: { id: '生成登录码' } }, [
a('a', { staticClass: 'header-anchor', attrs: { href: '#生成登录码' } }, [
t._v('#'),
]),
t._v(' 生成登录码'),
]),
t._v(' '),
a('p', [t._v('生成登录码接口')]),
t._v(' '),
a('ul', [a('li', [a('code', [t._v('GET')]), t._v(' /vip/gcode')])]),
t._v(' '),
a('p', [t._v('先决条件:')]),
t._v(' '),
a('ul', [a('li', [t._v('用户已登陆')]), t._v(' '), a('li', [t._v('为超级管理员')])]),
t._v(' '),
a('p', [
t._v('注: 生成登录码是由笔者写的'),
a('code', [t._v('加密算法')]),
t._v('实现, 不需要手动实现, 如果有自定义需求, 可以自行二次开发实现.'),
]),
t._v(' '),
a('p', [t._v('返回示例')]),
t._v(' '),
a('div', { staticClass: 'language-json extra-class' }, [
a('pre', { pre: !0, attrs: { class: 'language-json' } }, [
a('code', [
a('span', { pre: !0, attrs: { class: 'token punctuation' } }, [t._v('{')]),
t._v('\n '),
a('span', { pre: !0, attrs: { class: 'token property' } }, [t._v('"co"')]),
a('span', { pre: !0, attrs: { class: 'token operator' } }, [t._v(':')]),
t._v(' '),
a('span', { pre: !0, attrs: { class: 'token string' } }, [
t._v('"1x2fgggteee3456_zdd4"'),
]),
a('span', { pre: !0, attrs: { class: 'token punctuation' } }, [t._v(',')]),
t._v('\n'),
a('span', { pre: !0, attrs: { class: 'token punctuation' } }, [t._v('}')]),
t._v('\n'),
]),
]),
]),
a('p', [
a('code', [t._v('说明:')]),
t._v(' 为了保护用户信息安全, 返回的登录码是加密后的密文, 会调用笔者写的'),
a('code', [t._v('xib.xip')]),
t._v('方法进行加密, 如果想看到原始密码, 需要调用'),
a('code', [t._v('xib.uxip')]),
t._v('进行解密.'),
]),
t._v(' '),
a('h3', { attrs: { id: '获取用户真实密码' } }, [
a('a', { staticClass: 'header-anchor', attrs: { href: '#获取用户真实密码' } }, [
t._v('#'),
]),
t._v(' 获取用户真实密码'),
]),
t._v(' '),
a('p', [t._v('获取用户真实密码接口')]),
t._v(' '),
a('ul', [a('li', [a('code', [t._v('GET')]), t._v(' /vip/gcode/get')])]),
t._v(' '),
a('p', [t._v('先决条件:')]),
t._v(' '),
a('ul', [a('li', [t._v('用户已登陆')]), t._v(' '), a('li', [t._v('为超级管理员')])]),
t._v(' '),
a('table', [
a('thead', [
a('tr', [
a('th', [t._v('参数名')]),
t._v(' '),
a('th', { staticStyle: { 'text-align': 'center' } }, [t._v('是否必选')]),
t._v(' '),
a('th', { staticStyle: { 'text-align': 'center' } }, [t._v('类型')]),
t._v(' '),
a('th', { staticStyle: { 'text-align': 'right' } }, [t._v('说明')]),
]),
]),
t._v(' '),
a('tbody', [
a('tr', [
a('td', [t._v('co')]),
t._v(' '),
a('td', { staticStyle: { 'text-align': 'center' } }, [t._v('true')]),
t._v(' '),
a('td', { staticStyle: { 'text-align': 'center' } }, [t._v('string')]),
t._v(' '),
a('td', { staticStyle: { 'text-align': 'right' } }, [t._v('加密后的密码')]),
]),
]),
]),
t._v(' '),
a('p', [t._v('返回示例')]),
t._v(' '),
a('div', { staticClass: 'language-json extra-class' }, [
a('pre', { pre: !0, attrs: { class: 'language-json' } }, [
a('code', [
a('span', { pre: !0, attrs: { class: 'token punctuation' } }, [t._v('{')]),
t._v('\n '),
a('span', { pre: !0, attrs: { class: 'token property' } }, [t._v('"co"')]),
a('span', { pre: !0, attrs: { class: 'token operator' } }, [t._v(':')]),
t._v(' '),
a('span', { pre: !0, attrs: { class: 'token string' } }, [t._v('"12345678"')]),
a('span', { pre: !0, attrs: { class: 'token punctuation' } }, [t._v(',')]),
t._v('\n'),
a('span', { pre: !0, attrs: { class: 'token punctuation' } }, [t._v('}')]),
t._v('\n'),
]),
]),
]),
a('h3', { attrs: { id: '修改用户信息' } }, [
a('a', { staticClass: 'header-anchor', attrs: { href: '#修改用户信息' } }, [
t._v('#'),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[25],
{
400: function(v, _, l) {
394: function(v, _, l) {
'use strict';
l.r(_);
var i = l(42),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[26],
{
393: function(t, s, a) {
392: function(t, s, a) {
'use strict';
a.r(s);
var n = a(42),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[27],
{
396: function(_, v, t) {
395: function(_, v, t) {
'use strict';
t.r(v);
var a = t(42),
l = Object(a.a)(
i = Object(a.a)(
{},
function() {
var _ = this,
Expand All @@ -17,6 +17,23 @@
_._v(' 更新日志'),
]),
_._v(' '),
t('h4', { attrs: { id: '_1-95' } }, [
t('a', { staticClass: 'header-anchor', attrs: { href: '#_1-95' } }, [_._v('#')]),
_._v(' 1.95'),
]),
_._v(' '),
t('ol', [
t('li', [_._v('dooring文档添加更新日志模块')]),
_._v(' '),
t('li', [_._v('dooring增报错监控函数, 提供一键清空缓存按钮和自动重载功能')]),
_._v(' '),
t('li', [_._v('新增电商商品H5模版')]),
_._v(' '),
t('li', [_._v('页面配置增加背景模式和背景重复')]),
_._v(' '),
t('li', [_._v('表单添加字段名配置项')]),
]),
_._v(' '),
t('h4', { attrs: { id: '_1-94' } }, [
t('a', { staticClass: 'header-anchor', attrs: { href: '#_1-94' } }, [_._v('#')]),
_._v(' 1.94'),
Expand Down Expand Up @@ -79,7 +96,7 @@
null,
null,
);
v.default = l.exports;
v.default = i.exports;
},
},
]);
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[28],
{
394: function(t, s, a) {
396: function(t, s, a) {
'use strict';
a.r(s);
var n = a(42),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(window.webpackJsonp = window.webpackJsonp || []).push([
[30],
{
402: function(t, s, a) {
400: function(t, s, a) {
'use strict';
a.r(s);
var n = a(42),
Expand Down
Loading

0 comments on commit 8beefab

Please sign in to comment.