在写接口文档时,当参数过多怎么办?认命,一个个写下去?每个参数都有类型、参数说明和备注等信息,那得写到什么时候?特别是返回参数,随便一个获取详细信息的接口里返回的参数就够写一段时间,还得辛苦去整理文档格式。

其实不必这么麻烦,众所周知,在开发过程中,很多数据其实均参照json字符串标准,传入及传出数据一般符合json格式,那我们就可以充分利用json数据,来简化编写接口文档的操作,下面用eolinker接口管理平台给大家做演示。

1、进入接口文档编辑页面,点击导入json,输入标准json字符串


2、Json中的key便保存到参数名中,而value则保存到参数的默认值里


3、json导入还支持导入非标准json格式数据,即以"//"作为注释起点,导入json后,注释会被录入到参数说明中。导入后只需要简单地把剩余的参数信息一一填入即可。

最佳答案

评论() 相关

收藏

赞

lostrivers

ThinkPHP 是一个免费开源的,快速、简单的面向对象的 轻量级PHP开发框架 ,创立于2006年初,遵循Apache2开源协议发布,是为了敏捷WEB应用开发和简化企业应用开发而诞生的。ThinkPHP从诞生以来一直秉承简洁实用的设计原则,在保持出色的性能和至简的代码的同时,也注重易用性。并且拥有众多的原创功能和特性,在社区团队的积极参与下,在易用性、扩展性和性能方面不断优化和改进,已经成长为国内最领先和最具影响力的WEB应用开发框架,众多的典型案例确保可以稳定用于商业以及门户级的开发。