Restful接口规范-项目常用总结

请求接口

• @GetMapping("/xxx")。比如分页获取请求
• @PostMapping("/xxx")。插入、修改接口，简单的审核是否通过也需要。其中可有一个字段type，区分不同的修改
• @DeleteMapping("/xxx)。删除操作
• 列表某项的详情页/list/{id}/detail，为get请求，修改的话为post请求

请求参数

尽可能用基本类型Integer、String、Long、数组、Map

• 批量操作id，用Long[],

{"ids",[1,2]}

• 批量操作id对应的某属性，用Map<Long,String>

{"ids":{"1":"val1","2":"val2"}}

• 是否，用Boolean传参数

{"enabled":true}

• 时间类型用Long，与java中Date，数据库中datetime对应