统一命名规范:
我就发一下我的建议吧,如果你用vue就根据vue的命名规范来,因为大多人都是这样做的,方便管理,推荐一份
vue 开发命名规范 - 前端开发日志 - SegmentFault 思否
如果你用typescript的话,就按照typescript的命名规范来
一般页面开发规范指南
接口这些是没有什么限制的,文件名,架构,这些你就要和后端统一一下概述接口这些是没有什么限制的,文件名,架构,这些你就要和后端统一一下,可以采用驼峰式命名,也可以采用下滑线命名.开发文档,主要是api文档,目前用的是postman,主要是记录接口,仅做测试用.但是这远远是不足够的,还是要健全api文档,根据经验会有以下问题会出现bug,正常情况,后端只会告诉你success的返回,你看到的只有success的返回,如果你只是这样做,仍然会有问题,success也会有很多种情况,也许你只知道一种情况,在后面的开发也会有问题。后端完善接口文档.
api文档应有的格式,分为complete和fail,一般的fail,后端会有默认返回,其他的需要特殊处理
json默认格式
{
"data":{},
"status":"0",
"message":""
}
复制代码
先说一下状态码
200,302,404这些经常见到,后端返回的status也是不一样的,这里要跟后端以前协商一下,简单的就0和1。0就fail,1就complete,比如说权限控制,无权访问,或者是权限不够,只能访问一部分,就需要协商一下。1的话可能会有多种情况,返回也是不一样的,测试可能提出不一样的bug,比如后端查数据返回数据的格式可能是不完全的,一会返回"",一会返回[],或者干脆这个key都不返回了,那么前端这边就会抛出异常。
3.ajax请求约定,get或者post:
我目前都是统一用post,post更安全一点,数据长度无限制,不能缓存。
4.传输格式统一:
post请求,提交格式可能是formData形式也可能是json格式,一般用到的就这两种,后台可能用formData更方便,但是不灵活,由于前一个开发者用的formData,我和后端开发调试极为不方便。json更灵活些,我推荐用json。
5.图片路径:
有的项目图片路径是前端控制,分为绝对路径和相对路径,本地的资源一般都是用相对路径了,但是有的资源可能相对路径就用不了,比如说我们后端现在用的就是七牛云存储图片,如果是一个网站可能域名就固定了,这个就比较简单,前端请求图片资源的公共位置应该可以封装一下,我不知道哪个方法可以封装,我用的vue,axios请求回来图片的字段没有和后端约定,不知道怎么封装公共的图片资源地址,我这边是让后端去封装的,图片大小也是后端控制的,如果前端来控制岂不是更好
6.图片上传:
base64编码上传,我喜欢这个,因为可以弄压缩,也可以弄水印但是后端觉得太复杂,七牛云默认有压缩,form表单上传图片也是可以的,然后图片传上去,详情页会看到图片,这里强调一下,图片路径可能会有问题
7.用svn还是git:
我这里用的是git。
8.每次修改bug尽量能有文档:
不然就只能svn一个一个查了,svn必须有message提交。
9.本地数据:
永久的用local storage,临时的用session storage,移动端微信的cookie存储了那些授权的信息,所以微信这里就不要用cookie了
10.和设计小姐姐的约定:
图片采用png,图片发给我之前先压缩,然后打包成文件夹(能要求用英文给图片命名就英文吧),或者svn格式,移动端开发尺寸约定,iphone7的尺寸就好。750px,前端用rem处理。尺寸那些也让她标记了,不然谁知道那个字体有多大,颜色是什么。 PxCook - 最高效易用的自动标注工具,设计研发协作利器 有交互的地方也让她绘制了。不然你随便弄个,又不好看。
11.和产品的约定:
怎么弄交互,哪里用,一定要有原型图.产品提需求必须要有文档,没有文档的需求,你就不做。什么时候他说:"没有这个需求,这个需求不是我要求的",你就要背锅了.
随便介绍一下知乎地址