接口文档包括哪些内容

2024-09-23 12:01:12 业界科普

一份规范的接口文档应该包括什么内容

要了解接口文档的规范,首先要了解接口。接口分为四部分:方法、uri、请求参数、返回参数

1)方法:常用的方法就是下面的四种:GET PUT POST DELETE

2)uri:以/a开头,如果需要登录才能调用的接口(如新增、修改;前台的用户个人信息,资金信息等)后面需要加/u,即:/a/u;中间一般放表名或者能表达这个接口的单词。get方法,若果是后台通过搜索查询列表,那么以/search结尾,如果是前台的查询列表,以/list结尾。uri地址里不逊于出现大写字母,如果是两个单词拼接,用/分开

3)请求参数和返回参数:请求参数和返回参数都分为:字段、说明、类型、备注、是否必填这5列。

版权说明: 本文版权归原作者所有,转载文章仅为传播更多信息之目的,如作者信息标记有误,请第一时间联系我们修改或删除,多谢。