补完文档中

src/routes/main/modules/api-doc/domain.md

+# 作用域
+
+用户永远处于某一作用域下。作用域从高到低，
+分别是全市，区，项目，基地。每一个作用域都有自己的唯一编号。
+任意一个作用域可以用作用域路径来唯一标识。
+作用域路径即将此作用域从高到低的各个作用域的编号拼接成一个路径地址。
+特别的，全市的作用域路径为`/`。
+
+举个例子。假设黄浦区的作用域编号为HP，
+黄浦区下某项目的作用域编号为HP01，
+该项目下某基地的作用域编号为HP011，
+那么黄浦区的作用域路径为`/HP`；
+项目HP01的作用域路径为`/HP/HP01`；
+基地HP011的作用域路径为`/HP/HP01/HP011`.
+
+绝大多数接口都是受限于当前作用域的。
+处于错误的作用域，调用相同名称的接口，
+即使参数都一样，也往往产生错误的结果。
+所以登录验证后第一件事就是切换到正确的作用域。
+
+## 切换作用域
+
+当前作用域是临时地保存在服务端的，每次重新登录后，之前设置的作用域都将失效，必须重新设置。
+
+- **URL**:
+/api/domain/user/path
+
+- **Method**:
+POST
+
+- **Accept**:
+application/json
+  - *dmPath* - **string** 作用域路径
+
+- **Content-Type**: 
+application/json
+  - `null`
+  
+# 获取当前作用域路径
+
+- **URL**:
+/api/domain/user/path
+
+- **Method**:
+GET
+
+- **query parameter**
+  - 无 - 只包含前置说明中提到的token， 之后不再重复说明。
+
+- **Content-Type**: 
+application/json
+  - `null`

src/routes/main/modules/api-doc/dynamic-interface.md

-# 动态接口

src/routes/main/modules/api-doc/dynamic-interface/addFamily.md

+# 新增两清
+
+新增两清数据，支持批量。批量能有效提高性能，所以能批量就批量。
+
+## 前置条件
+
+- 必须切换到基地这一级别
+
+## 参数
+
+- data - 新增的数据，必须是数组，即使只有一条数据。
+
+  ```
+  [{
+    anZhiFangShi: string,
+    beiChaiQianRen: string,
+    buWeiPingGuJieHeChongXinDanJia: number,
+    chongZhiJieHeChengXin: number,
+    devices: [{
+    }],
+    erTai: string,
+    fangWuXingZhi: string,
+    fangWuZuoLuo: string,
+    fuShuWuJinE: number,
+    fuShuWus: [{
+    }],
+    heDingMianJi: number,
+    identityCard: string,
+    isLocked: string,
+    jiXiRiQi: date,
+    juMinFenZu: string,
+    juMinLeiXing: string,
+    leiXing: string,
+    number: string,
+    pingGuMianJi: number,
+    shiCeMianJi: number,
+    tuDiZhengHao: string,
+    weiRenDingMianJi: number,
+    wuZhengMJ: number,
+    yingJianWeiJian: string,
+    yingJianWeiJianMJ: string,
+    youZhengDuoYuMianJi: string,
+    youZhengDuoYuMJ: string,
+    youZhengMianJi: string,
+    zhaiJiDiShiYongZheng: string
+  }]
+  ```
+
+## 返回值
+
+`[int]` - 新增的两清的id

src/routes/main/modules/api-doc/dynamic-interface/index.md

+# 动态接口
+
+动态接口可以可以看作函数，有参数，有返回值。
+具体执行的内容在后台由技术人员进行配置，
+理论上任何任务都可以通过这个api完成。
+因为是可配置的，所以称之为**动态**的，
+不过一般情况下，进入生产环境配置好的接口不会轻易改动，
+除非有bug。
+
+- **URL**:
+/api/interface/user/{name}/invoke
+  - *name* - 动态接口的名称，可以认为是动态接口的唯一标识符。
+
+- **Method**:
+POST
+
+- **Accept**:
+application/json
+  - *params* - **object** 动态接口的参数，类似函数的参数。
+    任意键值对，键为字符串，值为任意合法的**json**值类型。
+    具体的形式依赖于当前动态接口的配置。
+    
+- **Content-Type**: 
+application/json 
+  - \- **any** 返回值没有固定类型，完全依赖于配置。

src/routes/main/modules/api-doc/dynamic-interface/removeFamily.md

+# 删除两清

src/routes/main/modules/api-doc/dynamic-interface/updateFamily.md

+# 更新两清
+
+更新两清数据，支持批量。批量能有效提高性能，所以能批量就批量。
+
+## 前置条件
+
+- 必须指定两清id
+- 只有解锁的两清数据才能进行修改
+
+## 参数
+
+- data - 更新的数据，必须是数组，即使只有一条数据。
+
+  ```
+  [{
+    id: int,
+    anZhiFangShi: string,
+    beiChaiQianRen: string,
+    buWeiPingGuJieHeChongXinDanJia: number,
+    chongZhiJieHeChengXin: number,
+    devices: [{
+    }],
+    erTai: string,
+    fangWuXingZhi: string,
+    fangWuZuoLuo: string,
+    fuShuWuJinE: number,
+    fuShuWus: [{
+    }],
+    heDingMianJi: number,
+    identityCard: string,
+    isLocked: string,
+    jiXiRiQi: date,
+    juMinFenZu: string,
+    juMinLeiXing: string,
+    leiXing: string,
+    number: string,
+    pingGuMianJi: number,
+    shiCeMianJi: number,
+    tuDiZhengHao: string,
+    weiRenDingMianJi: number,
+    wuZhengMJ: number,
+    yingJianWeiJian: string,
+    yingJianWeiJianMJ: string,
+    youZhengDuoYuMianJi: string,
+    youZhengDuoYuMJ: string,
+    youZhengMianJi: string,
+    zhaiJiDiShiYongZheng: string
+  }]
+  ```
+
+## 返回值
+无

src/routes/main/modules/api-doc/index.js

-// import React from 'react';
 import { connect } from 'dva';
-// import mdIndex from './index.md';
-// import mdAuth from './auth.md';
 import route from '../../../../components/hoc/routes';
 import Main from './main';
 
-// const md = mdString => () => (
-//   <div style={{
-//     padding: '1em',
-//     background: '#fafafa',
-//   }}
-//   >
-//     <ReactMarkdown className="markdown-body" source={mdString} />
-//   </div>
-// );
-
 export default connect(({ apiDoc }) => ({ apiDoc }))(route({
   childRoutes: [{
     path: 'main',

src/routes/main/modules/api-doc/main.js

@@ -7,7 +7,11 @@ import 'github-markdown-css';
 import styles from './index.less';
 import mdIndex from './index.md';
 import mdAuth from './auth.md';
-import mdDyInt from './dynamic-interface.md';
+import mdDomain from './domain.md';
+import mdDyInt from './dynamic-interface/index.md';
+import mdDyAddFamily from './dynamic-interface/addFamily.md';
+import mdDyUpdateFamily from './dynamic-interface/updateFamily.md';
+import mdDyRemoveFamily from './dynamic-interface/removeFamily.md';
 
 const md = mdString => props => (
   <div style={{
@@ -32,8 +36,16 @@ class DocMainPage extends React.Component {
             <li>
               <Link to={`${match.url}/auth`}>登录与认证</Link>
             </li>
+            <li>
+              <Link to={`${match.url}/domain`}>作用域</Link>
+            </li>
             <li>
               <Link to={`${match.url}/dynamic-interface`}>动态接口</Link>
+              <ul>
+                <li><Link to={`${match.url}/dynamic-interface/addFamily`}>新增两清</Link></li>
+                <li><Link to={`${match.url}/dynamic-interface/updateFamily`}>更新两清</Link></li>
+                <li><Link to={`${match.url}/dynamic-interface/removeFamily`}>删除两清</Link></li>
+              </ul>
             </li>
           </ul>
         </Affix>
@@ -41,7 +53,17 @@ class DocMainPage extends React.Component {
           <Switch>
             <Route path={`${match.path}/index`} component={md(mdIndex)} />
             <Route path={`${match.path}/auth`} component={md(mdAuth)} />
-            <Route path={`${match.path}/dynamic-interface`} component={md(mdDyInt)} />
+            <Route path={`${match.path}/domain`} component={md(mdDomain)} />
+            <Route path={`${match.path}/dynamic-interface`} exact component={md(mdDyInt)} />
+            <Route path={`${match.path}/dynamic-interface/addFamily`} component={md(mdDyAddFamily)} />
+            <Route path={`${match.path}/dynamic-interface/updateFamily`} component={md(mdDyUpdateFamily)} />
+            <Route path={`${match.path}/dynamic-interface/removeFamily`} component={md(mdDyRemoveFamily)} />
+            <Route path={`${match.path}/dynamic-interface/addHouse`} component={md(mdDyAddFamily)} />
+            <Route path={`${match.path}/dynamic-interface/updateHouse`} component={md(mdDyAddFamily)} />
+            <Route path={`${match.path}/dynamic-interface/removeHouse`} component={md(mdDyAddFamily)} />
+            <Route path={`${match.path}/dynamic-interface/addPeople`} component={md(mdDyAddFamily)} />
+            <Route path={`${match.path}/dynamic-interface/updatePeople`} component={md(mdDyAddFamily)} />
+            <Route path={`${match.path}/dynamic-interface/removePeople`} component={md(mdDyAddFamily)} />
           </Switch>
         </div>
       </div>