在写接口文档时,当参数过多怎么办?认命,一个个写下去?每一个参数都有类型、参数说明和备注等信息,那得写到何时?特别是返回参数,随便一个获取详细信息的接口里返回的参数就够写一段时间,还得辛苦去整理文档格式。 json
其实没必要这么麻烦,众所周知,在开发过程当中,不少数据其实均参照json字符串标准,传入及传出数据通常符合json格式,那咱们就能够充分利用json数据,来简化编写接口文档的操做,下面用eoLinker接口管理平台给你们作演示。spa
一、进入接口文档编辑页面,点击导入json,输入标准json字符串blog
二、Json中的key便保存到参数名中,而value则保存到参数的默认值里接口
三、json导入还支持导入非标准json格式数据,即以“//”做为注释起点,导入json后,注释会被录入到参数说明中。导入后只须要简单地把剩余的参数信息一一填入便可。图片
是否是很简单呢?开发