基于node的api接口
node的主要用途之一就是可以进行后台的api接口开发,前端存在系列的规范守则优化,而后台也同样不少,下边就列举写常见的api接口规范。
api路径规范
api就是接口的意思,为了区别常见的/index/xx路径,一般需要再路径中带上api目录或者express之类中虚拟路径。
let indexRouter = require('./routes/index');
//这里为接口的请求路径
let apiRouter = require('./routes/api');
app.use('/', indexRouter);
app.use('/api', apiRouter);
//router文件下api.js中 此时请求 .../api/banner
router.get('/banner',(req,res)=>{});
api命名规范
命名规范和前端差不错,都可以aB驼峰命名或者下划线a_b命名,不同的是一般是curd(数据库操作)前缀加上名字。
//add/update/delete/get 增删改查
addUser 添加用户
deleteBanner 删除轮播图
updatePwd 修改密码
getVideoList 获取视频列表
请求参数规范
前端的小伙伴都知道私有请求用post,而公开的get请求会把参数带在地址栏,类似百度搜索的时候,其实尽量全部post没毛病。
返回数据规范
没特殊情况下,一般返回数据表里,node指带文档(json形式)最新的数据。一般必包含几个参数。
status 状态 200/404/403 成功/不存在/重复请求不修改
msg 提示信息 success/fail
list 无的话一般[]
...
接口文档说明
写的api接口没有说明,过段时间估计开发自己都会一脸懵,所以说明必不可少。
//简单的备注(非完整)
/**
* 获取当前视频信息
* @param id {number} 视频id
* @param userName {string} 用户姓名
* @return json [{"name":"视频名字","preImg":"预览图"},..]
*/
router.post('/api/videoIntro',(req,res)=>{
let params=req.body
})
网友评论