jsontointerface

jsontointerface

convert json data to interface files；
writen by @shincat.

despection

这是一个工具，主要用于typescript项目中，当后端返回的数据接口比较复杂时，省去了一个一个去写interface的步骤，而是直接根据后端返回的数据结构，遍历生成包含各个数据接口的interface描述，并保存为对应的ts文件。具体描述如下

install

npm install --save-dev jsontointerface

init初始化

 j2i init
 或者
 npx j2i init

然后在你的项目目录下就会出现一个 j2i.json 的配置文件;
和一个j2i的目录， 目录的大致结构

-root--
    |- j2i/
    |- node_modules/
    |- package.json
    |- j2i.json

j2i.json 为json2interface的配置文件 数据结构为：

 
{
    "files":{
        "filepath":"j2i",
        "filepathto":"D"
    },
    "options":{
        "readonly":true,
        "toD":true
    }
}
 

关键字段	描述	备注
filepath	需要解析的json方式的目录	默认为j2i，建议保持默认，字符串
filepathto	ts的interface 文件放置的位置	字符串,一个名叫userdata.d.json 将会在这个目录下编译成 Iuserdata.ts 的文件
readonly	是否将interface 个各个字段描述为readonly	默认为true，都为“只可读”
toD	是否保存为“.d.ts”后缀文件	默认为true

sample

有一个名为 username.json的json文件，数据结构为：

{
    "apiname":"getusername",
    "code":"456",
    "result":{
        "code":"123",
        "data":{
            "username":"shincat",
            "userinfo":"from changzhou",
            "userage":"30",
            "list":["2"]
        }
    },
    "history":[{
        "time":"34"
    }]
}

将 其放置在 j2i目录下。 之后直接运行

j2i
或者
npx j2i

根据以上j2i.json的配置文件的配置项，将在D目录下生成一个 Iuserdata.d.ts的文件。这个文件的内容为：

interface Ickindex {
   readonly apiname?:string;
   readonly code?:string;
   readonly result?:IData0;
   readonly history?:Array<IData2>;
};
interface IData2 {
   readonly time?:string;
};
interface IData0 {
   readonly code?:string;
   readonly data?:IData1;
};
interface IData1 {
   readonly username?:string;
   readonly userinfo?:string;
   readonly userage?:string;
   readonly list?:Array<string>;
};
 
 export type {Ickindex,IData2,IData0,IData1}

之后你就可以愉快的在你的typescript中import 这些文件，在编译器中方便的获取对象属性啦。