一.首先明白什么是前后端?
前端:前端即网页前台部分,运行在 PC端,移动端等以浏览器的方式展现给用户浏览的网页,我自己的理解是拆开的:前指可视的样子就像人与人相交流,端指设备终端。
后端:简单来说,后端开发就是开发人员编写的不能直接看到的代码。后端主要负责应用程序中的业务逻辑,以及从前端提取和检索数据。还有就是是从数据库或其他数据源写入、读取和处理数据。
二.什么是前后端分离开发模式?前后端分离的开发模式:系统分析阶段,系分和前端开发人员约定好页面上所需的逻辑变量,进入功能开发阶段,前端开发人员进行前台页面结构,样式,行为层的代码编写,并根据约定好的变量,逻辑规则,完成不同情况展示不同的表现。而后端开发人员,只需要按照约定,赋予这些变量含义,并提供前后端交互所需要的数据即可。
三.如何实现前后端良好的联调协作那?沟通:项目开发之前,尽可能主动的和系统分析师和交互设计师多沟通,确定页面中交互与服务器端交换数据的接口、方式、格式等,让前后端约定更丰满一些。因为她越丰满,后面的纠结就越少。协作:功能开发过程中,需要建立一个共同调试的环境,方便前后端同学协同开发。接口文档:一个规范的接口文档在前后端联调协作的时候至关重要。
四.为什么要写接口文档?
1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发
2、项目维护中或者项目人员更迭,方便后期人员查看、维护
五.接口规范是什么?
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里是具体的参数。
6.生成接口文档的工具有哪些
1.swagger:通过源代码注释生成接口文档的工具
2.apipost:通过对接口测试,返回的响应生成接口文档。可以生成在线版,html、markdown、word等格式的接口文档。

6ad19848da5de26b425ea037679aad9a.png

这里我一般使用apipost,因为它既可以验证接口是否正确,还可以生成各种格式的接口文档。还能让前端人员一起在一个团队协作进行联调。

ApiPost - 可直接生成文档的API调试、管理工具​www.apipost.cn
afd0dbfc6c4ea8bc70707b9791796ba7.png
Logo

快速构建 Web 应用程序

更多推荐