当前位置: > 财经>正文

什么是接口文档,如何写接口,有什么规范? 外汇交易api接口文档是什么意思呀怎么弄出来的

2023-09-12 07:19:50 互联网 未知 财经

什么是接口文档,如何写接口,有什么规范?

方法:新增(post) 修改(put) 删除(delete) 获取(get)

接口详情地址www.baidu.com方式GET

uri:以/a开头,如果需要登录才能调用的接口(如新增、修改;前台的用户个人信息,资金信息等)后面需要加/u,即:/a/u;中间一般放表名或者能表达这个接口的单词;get方法,如果是后台通过搜索查询列表,那么以/search结尾,如果是前台的查询列表,以/list结尾;url参数就不说了中间一般放表名或者能表达这个接口的单词;get方法,如果是后台通过搜索查询列表,那么以/search结尾,如果是前台的查询列表,以/list结尾;url参数就不说了

请求参数和返回参数,都分为5列:字段、说明、类型、备注、是否必填字段是类的属性;说明是中文释义;类型是属性类型,只有String、Number、Object、Array四种类型;备注是一些解释,或者可以写一下例子,比如负责json结构的情况,最好写上例子,好让前端能更好理解;是否必填是字段的是否必填。

返回参数结构有几种情况:

返回接口调用成功还是失败(如新增、删除、修改等),如下图:

返回结果格式JSON状态码200success(成功)状态码500error(失败)状态码501param error(参数错误).........

如果要返回某些参数,则有两个结构体:1是code/mesage/data,2是data里写返回的参数,data是object类型;

如果要返回列表,那么有三个结构体,1是code/mesage/data,data是object,里面放置page/size/total/totalPage/list 5个参数,其中list是Arrary类型,list里放object,object里是具体的参数。

注意:uri地址里不允许出现大写字母,如果是两个单词拼接,用/分开

版权声明: 本站仅提供信息存储空间服务,旨在传递更多信息,不拥有所有权,不承担相关法律责任,不代表本网赞同其观点和对其真实性负责。如因作品内容、版权和其它问题需要同本网联系的,请发送邮件至 举报,一经查实,本站将立刻删除。