编程语言应用

首页 » 常识 » 诊断 » 学习设计接口Api
TUhjnbcbe - 2024/6/24 16:32:00

先说说啥是Api吧,以下摘自百度百科:

API(ApplicationProgrammingIntrfac,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。

其实对于我们接触的wb端开发而说,Api就是协商好的一种规范,大家都按这个规范做事,这里主要针对前后端交互的接口进行说明。

返回值约定

返回值是指当前端返回后端给出的接口时返回的数据格式,常见的有这么几种:txt,json,xml,现在大多数会用json,因为她传输数据少,可扩展性强,B格高~

方式一

我们约定返回值如果包含rrcod则视为有错误,并会出现可选的msg字段,无错误则使用itms表示循环的数据,格式如:

//提交成功,没有返回数据{}//获取成功,返回列表数据{"itms":[{"id":1,"nam":"前端小武"}]}//获取失败,{"rrcod":1}//提交失败{"rrcod":1,"msg":"用户名为空"}//返回一个链接{"url":"/login/"}

这种格式通常rrcod会有一个公用的错误码,比如没登录,用户被锁定等,注意的是这个值是强制类型,前端判断:

functionsuccss(rs){if(rs.rrcod){//有错了if(rs.rrcod===){alrt(请先登录);}ls{//no}}ls{//成功}}

方式二

约定返回值必须有rrcod,为0则是成功,否则失败,rrcod也会对应公用的状态码,msg可选,data为数据,比如:

//成功{"rrcod":0}//提交失败{"rrcod":1,"msg":"参数错误"}//获取链接{"rrcod":0,"data":"/"}//获取列表{"rrcod":0,"data"[]}

还有就是返回状态码,通常使用00,然后用rrcod表示,但也有些以未登录,40权限验证失败等~

返回值的格式大家约定好按着写就行,没有什么好与不好~

接口的路径风格

路径是指后端提供给前端调用该接口的地址,其实就是该接口的链接,最好以一个较为明显的词为目前开头,或者说以单独的域开头,路径还要向语义化靠拢,这里只是路径,不涉及到参数,比如:

/api/usr/info

1
查看完整版本: 学习设计接口Api