(办公)写代码的任务完成后,编写接口文档

1.接口文档首页(描述什么系统,哪些类型的接口,接口的完成程度等),例如:管理端接口清单

1.1.No:编号(1,2,3..)

1.2.模块/页面(比如商城的客户管理)

1.3.接口名称(比如接口的作用)

1.4.请求API(访问那个api)

1.5.动作(event)(访问那个api的某个接口方法)

1.6.支持协议(一般是http)

1.7.功能(比如接口的作用)

1.8.操作标签(主要的操作 select,update,add,delete )

1.9.接口需求(比如接口的作用)

2.0.发布状态(已完成,未测试,这些状态)

   接口文档首页完成之后,通过点击动作,就会访问到excel的一个sheet里.

2.每个sheet的编写

2.1. sheet主要描述:(接口的功能描述,内容,规则)

2.1.1 内容一般分为:(接口名,请求API,动作(event),安全性,请求内容格式,响应内容格式,备注),跟内容相对应的就写在规则中.

2.2. sheet的主要传参数,返回参数:

2.2.1:(传参数/返回参数)例如(参数,参数名称,类型,必填,描述,范例)

2.3.参考的DB对象.(No,物理的表名,逻辑名(就是这个实体类做什么))