EasyAPI JSON 注释显示组件

组件命名

easyapi-json-view

组件描述

EasyAPI JSON 注释显示组件，主要作用就是美化显示 JSON 数据，在此基础上，多一个类型和注释（类型一般 JSON 显示组件也有）。

组件效果图

颜色说明：注释 背景底色 字体颜色，类型

2 个数据格式

传入数据包括 2 个 JSON 数据对象

1、标准 JSON 数据

用来显示 JSON 的基础数据，使用 pre 标签，风格采用 2、JSON 注释数据 默认勾选数据类型、数据注释，如图所示显示数据类型与数据注释，

方法说明

1、showType 显示数据类型（字段类型）

2、showDescription 显示数据注释（字段描述）

更多

数据类型（字段类型）

string, number, boolean, integer, float, double, object, array

Props

| Props | 中文 | | ----------- | ------------ | | jsonData | json data | | commentData | comment data |

| commentData | 中文 | | ------------ | ----------- | | name | key name | | remark | 注释 | | childParams? | childParams |

Example

<easyapi-json-view :jsonData="jsonData" :commentData="commentData"></easyapi-json-view>

<script>

export default {
  name: "app",
  data: function() {
    return {
      commentData: [
        {
          name: "dddd",
          remark: "232"
        },
        {
          name: "fff",
          remark: null,
          childParams: [
            {
              name: "fasd",
              remark: "22"
            },
            {
              name: "vvv",
              remark: "fff"
            }
          ]
        },
        {
          name: "vvv",
          remark: "123"
        }
      ],
      jsonData: {
        dddd: 1234,
        fff: {
          fasd: "213",
          vvv: "12312"
        },
        vvv: "ass"
      }
    };
  },
  mounted: function() {}
};
</script>

目录结构

├── dist                      打包后产物
├── example                   运行用例
├── src                       源码
│   ├── utils                 工具包
│   ├── JsonView.vue          组件源码
│   ├── assets                资源
│   │   ├── font              字体
│   │   └── styles            样式
│   └── index.js
├── webpack.base.js           webpack配置基础
├── webpack.build.js          webpack配置prod
└── webpack.config.js         webpack配置dev