当前位置: 首页 > news >正文

创建网站哪个好经典软文案例和扶贫农产品软文

创建网站哪个好,经典软文案例和扶贫农产品软文,wordpress占用内存过大,赤峰做网站哪家好一、什么是接口文档? 在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。 二、为什…

一、什么是接口文档?

在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。

二、为什么要写接口文档?

1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发

2、项目维护中或者项目人员更迭,方便后期人员查看、维护

三、接口规范是什么?

首先接口分为四部分:方法、uri、请求参数、返回参数

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

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

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

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

4、返回参数结构有几种情况:1、如果只返回接口调用成功还是失败(如新增、删除、修改等),则只有一个结构体:code和message两个参数;2、如果要返回某些参数,则有两个结构体:1是code/mesage/data,2是data里写返回的参数,data是object类型;3、如果要返回列表,那么有三个结构体,1是code/mesage/data,data是object,里面放置page/size/total/totalPage/list 5个参数,其中list是Arrary类型,list里放object,object里是具体的参数。

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

示例:

请求地址:get /a/student/list

请求参数:

返回参数:

如果我的博客对你有帮助、如果你喜欢我的博客内容,请 “点赞” “评论” “收藏” 一键三连哦!

http://www.dinnco.com/news/36723.html

相关文章:

  • 宝坻网站建设抖音seo怎么做
  • 西安学校网站建设费用百度权重提升
  • 宁波网站建设制作公司哪家好查企业信息查询平台
  • 建设的招标网站专业seo公司
  • 辛集市住房和城乡建设局网站南昌seo网站管理
  • 生活在线线下6家实体店地址seo有哪些网站
  • 赣州专业企业网站建设微信朋友圈营销文案
  • 商城网站开发周期网站推广文章
  • 网站如何做cdn建站快车
  • 网站自适应屏幕百度关键词怎么排名
  • 公司做网站建设价格市场调研报告
  • 设计学专业蜗牛精灵seo
  • 学院网站建设意义网络搜索词排名
  • 网站建设 常用字体外贸网站推广平台
  • 桓台建设网站百度客户端
  • 网站建设 善辉网络网上销售都有哪些平台
  • iis5.1 建立网站附近电脑培训速成班一个月
  • 青岛北京网站建设外贸平台
  • 庆阳设计公司苏州seo优化公司
  • 网站如何做绿标网站页面的优化
  • 免费做网站页头图谷歌在线浏览入口
  • 贵州今天疫情新增消息前端优化
  • 有限责任公司和有限公司的区别毕节地seo
  • 美文的手机网站免费职业技能培训网
  • 区块链做网站都有哪些内容呢免费网站站长查询
  • 网站开发人员工作内容查询百度关键词排名
  • 自己做的网站被黑了怎么办网络营销怎么做推广
  • 做网站的公司好坑啊软文推广的优点
  • 网站下载下来怎么做后台惠州seo排名
  • 免费信息发布潍坊网站建设seo