1、 标明字段的名称、数据类型、最大长度、不足最大长度时是否在数据前/后补空格、是否可为null、是否可不传、描述说明
name字段可为null的数据示例：{"id":1, "name":null}
name字段可不传的数据示例：{"id":1}
2、 数值字段需要标明可接受的小数位数、最大值、最小值、是否接受千分号（"100,000"）、是否可接受科学记数法表示（"1E6"）、是否可接受省略小数点前/后的0（".1"、"1."）
3、 与货币有关的数值字段，需要标明单位是“元”还是“分”
4、 日期、时间字段需要标明格式，如"yyyy-MM-dd"
5、 字符串字段要标明编码，如“UTF-8”，“GBK”
6、 字符串字段如果有最小长度限制、正则表达式匹配限制或其他限制，也需要标明
7、 按字符串搜索的接口，需要标明是准确匹配，前缀匹配，还是部分匹配
8、 最好给出正常的接口调用的输入输出数据的样例
9、 定义好发生异常时返回的数据
例如用户名密码登录的接口，要定义好数据库访问失败、用户不存在和密码错误等异常的返回