# data_gather_record

**Repository Path**: qbitoy/data_gather_record

## Basic Information

- **Project Name**: data_gather_record
- **Description**: No description available
- **Primary Language**: NodeJS
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2017-10-11
- **Last Updated**: 2022-04-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# data_gather_record

### 环境
* Node.js 版本：[10.x](https://nodejs.org/en/)
* 项目编辑器：[vscode](https://code.visualstudio.com/)
* Web 框架：[koa 2.x](https://koa.bootcss.com)
* 模板引擎：[Nunjucks 3.x](https://www.npmjs.com/package/nunjucks)
* CSS 框架：[Bootstrap 3.x](https://v3.bootcss.com/)
* Booststrap 插件: [bootstrap-table 1.12.x](https://github.com/wenzhixin/bootstrap-table)
* Excel 导出：[xlsx-populate 1.x](https://www.npmjs.com/package/xlsx-populate)
* SQLite 导出: [sqlite3 4.x](https://www.npmjs.com/package/sqlite3)
* VIP 编码引用：[hi-base32 0.5.x](https://www.npmjs.com/package/hi-base32)
* 其他 JS 库：[jQuery 3.x](http://api.jquery.com/)

### 程序启动
* 初始化模块：npm install
* 普通启动：node --use_strict app.js
* 调试启动（修改程序后自动重载）：node-dev --use_strict app.js

### 模块查看
* 查看局部模块：npm list --depth=0
* 查看全局模块：npm list --depth=0 -global

---

### 关于“采集字段说明”部分
#### 1.数据库存储格式
 
 - 类型名称 doc_type
 - 字段名称 field_name
 - 字段说明 field_intro
 - 字段样例 field_sample
 
#### 2.新增
##### 2.1 类型的新增
默认把系统原有的字段名称(去重)后附在新增加的类型上面，字段说明，字段样例附初值；
 
##### 2.2 字段的新增
 默认把系统所有的类型(去重)后附在新增加的字段上面，字段说明，字段样例附初值；
 
#### 3.删除
##### 3.1 类型的删除
 所有包含类型字段的记录删除
##### 3.2 字段的删除
 所有包含字段的记录删除
 
#### 4. 修改
##### 4.1 类型的修改
 修改表中的类型名称
##### 4.2 字段的修改
 修改表中所有的字段值
##### 4.3 修改所属类型的字段描述
##### 4.4 修改所属类型的字面样例

#### 5. 导出
##### 5.1 Excel导出

   - 大表(行:字段,列:类型) + 字段说明
   - 大表(行:字段,列:类型) + 字段样例
   - 类型表(行:字段,列：字段样例\字段说明)
##### 5.2 SQLite导出
   - 导出所有的字段
   - 导出相应类型所有的字段(过滤掉字段说明和字段样例都为-1)

##### 6 字段排序

#### 6. 接口描述
##### 6.1 所有类型及字段展示(bootstrap table)
   - 请求地址
   
   | 请求方式 |请求地址|
   | :-------- | :--------|
   | GET | /gather_field/data,column |
   

  - 请求参数
  - 返回值
  
    ```
      {
        "docType":[],
        "fileNames":[]
        "docType1":{
            "fieldName1":{
                "field_intro":"",
                "field_sample":""
            }
        },
        "docType1":{
            "fieldName1":{
                "field_intro":"",
                "field_sample":""
            }
        },
      }
      
   
   

   
##### 6.2 类型新增
  - 请求地址
    
    | 请求方式 |请求地址|
    | :-------- | :--------|
    | POST | /gather_field/addDoc |
  - 请求参数
  
     | 字段 |名称|是否必须
     | :-------- | :--------|:--------|
     | docTypeName |类型名称|是
     
  - 返回值
  
      ```
      {
          message:"创建成功"
      }
    
      ```

##### 6.3 类型详情
  - 请求地址
    
    | 请求方式 |请求地址|
    | :-------- | :--------|
    | GET | /gather_field/:docTypeName |
  - 请求参数
  
     | 字段 |名称|是否必须
     | :-------- | :--------|:--------|
     | docTypeName |类型名称|是
     
  - 返回值
  ```
    [
        {
         "fieldName":"",
         "fieldIntro":"",
         "fieldSample":""
        },
    ]
```
##### 6.4 类型删除
 - 请求地址
    
    | 请求方式 |请求地址|
    | :-------- | :--------|
    | DELETE | /gather_field/:docTypeName |
 - 请求参数
  
     | 字段 |名称|是否必须
     | :-------- | :--------|:--------|
     | docTypeName |类型名称|是
     
 - 返回值
 
      ```
        {
            "message":"类型删除成功"
        }
      ```
##### 6.5 字段新增
  - 请求地址
     
     | 请求方式 |请求地址|
     | :-------- | :--------|
     | POST | /gather_field/addField |
  - 请求参数
   
      | 字段 |名称|是否必须
      | :-------- | :--------|:--------|
      | fieldName |字段名称|是
      | fieldIntro |字段描述|否
      | fieldSample |字段样例|否
      
  - 返回值
  
    ```
      {
          "message":"字段新增成功"
      }
    ```
    
##### 6.6 字段更新
  - 请求地址
     
     | 请求方式 |请求地址|
     | :-------- | :--------|
     | POST |/gather_field/edit |
  - 请求参数
   
      | 字段 |名称|是否必须
      | :-------- | :--------|:--------|
      | fieldName |字段名称|是
      | fieldIntro |字段描述|是
      | fieldSample |字段样例|是
      | docTypeName |类型名称|是
      
  - 返回值
  
    ```
      {
          "message":"字段新增成功"
      }
    ```
    
##### 6.7 字段删除
  - 请求地址
     
     | 请求方式 |请求地址|
     | :-------- | :--------|
     | DELETE | /field/:docTypeName |
  - 请求参数
   
      | 字段 |名称|是否必须
      | :-------- | :--------|:--------|
      | fieldName |字段名称|是
      
  - 返回值
  
    ```
      {
          "message":"字段删除成功"
      }
    ```
##### 6.8 字段排序
  - 请求地址
     
     | 请求方式 |请求地址|
     | :-------- | :--------|
     | POST | /gather_field/sort |
  - 请求参数
   
      | 字段 |名称|是否必须
      | :-------- | :--------|:--------|
      | newFieldSort |排序后的字段|是
      
  - 返回值
  
    ```
      {
          "message":"字段删除成功"
      }
    ```
##### 6.9 SQLite导出 
  - 请求地址
     
     | 请求方式 |请求地址|
     | :-------- | :--------|
     | GET | /gather_field/db3 |
  - 请求参数
   
      | 字段 |名称|是否必须
      | :-------- | :--------|:--------|
      | exportType |导出类型|是(docType,docDetail)
      | docTypeName |文档详情|否
      
      
  - 返回值
  
    ```
      {
          "message":"字段删除成功"
      }
    ```
##### 6.10 Excel导出 
  - 请求地址
     
     | 请求方式 |请求地址|
     | :-------- | :--------|
     | GET | /gather_field/xls_docType|
     | GET | /gather_field/xls_detail|
  - 请求参数
   
      | 字段 |名称|是否必须
      | :-------- | :--------|:--------|
      | docTypeName |xls_detail|是
      
  - 返回值
  
    ```
      {
          "message":"字段删除成功"
      }
    ```