09_项目API文档

一,怎么写API文档:

1)API文档其实描述项目中的功能,现在建议遵守RESTful风格
2)描述性文本尽量占到50%以及以上
3)格式清晰,规范,风格统一
4)业务逻辑设计时,全面,合理

写的好的标准:大家都读得懂,给个小白看也能看懂
三要素:URL,提交的数据,响应的数据

二,目标

学会看项目API文档
学会根据API文档整理出接口清单
学会对API文档中有不清楚的业务该如何在API接口清单内体现

09_项目API文档

API文档作用:

09_项目API文档

三,解析API文档

1)单词功能拆解
1,href节点:资源请求地址
"href":" http://127.0.0.1:8000/api/departments/"

2,items节点:
为服务器响应数据时返回的资源属性;
(请求接口时,返回的资源属性要与items里的属性相符,jmeter填在Body Data中的格式,就是键值对那些)

3,Links节点:
当下资源包的直属下属
departments的直属小弟classes

4,templates节点:
这个才是jmeter填在Body Data中那些更新和新增玩意,json报文属性

5,queries节点:
为资源支持的查询列表参数名和查询条件
(资源支持哪些属性可以list查询;支持做查询条件的属性) 
$dep_id_list=A,B,C---就是这玩意

6,error节点作用说明:
出现错误时,返回的报文格式和属性
(如果请求资源有误,在响应数据时应在error节内体现) 
2)查询
1,href/?$def_if_list=id1,id2
2,href/?dep_name=name&master_name=masterName&slogan=sloga
(默认不会开启模糊查询的,需要的话,blur=1 开启)