1、接口参数
A 接口参数中,如果有表示类型的参数,需要将这个接口所有的这个类型提供全部的列表,不然用这个接口的人不知道有哪一些类型。
B 接口参数中,如果有用简单字符串或者数字代表某个意义,一定要讲这个简单字符串或者数字代表的意义详细说明。
2、接口表述
A 接口的作用是什么,用来获取数据么、用来写入保存数据么
B 接口参数的规则需要详细写清楚
C 接口结果如果需要,也要详细说明参数意义,如果也有上述1、接口参数中的情况,也要按照上面写清楚,提供详细列表
总结:不要废话也不要太简单,列表多应用
仅供自己笔记