接口定义规范是，类的路径固定，有自己唯一的前缀；请求方式尽量要做到符合语义；接口返回对象统一；定义统一的返回码格式。
本文操作环境：windows10系统、thinkpad t490电脑。
接口定义
restful风格，类的路径固定，有自己唯一的前缀； 方法路径纯名词，通过请求方式表示语义是查询还是添加，多个单词用短横线连接。增加版本号管理。定义的时候做好参数校验。如果用对象接受，禁止请求对象在多个方法公用，不需要的参数不允许定义在对象里。且请求参数字段尽量与表对象字段保持一致。
示例：
请求方式
请求方式尽量做到符合语义，
查询GetMapping
新增PostMapping
修改PutMapping
删除DeleteMapping
接口返回
接口返回对象统一
返回的对象统一封装成xxxDto对象，需要什么返回什么，禁止直接返回表实体类。
返回码处理
定义统一的返回码格式
异常处理
加上全局的异常处理，定义几种主要的业务异常，可以在全局处理处统一捕获，并返回对应的返回码。
方法定义
前缀最好统一，不要add，insert，get，query等混用，
可以统一如下：
查询getxxx
列表查询getxxxList
添加addxxx
修改updatexxx
删除deletexxx
以上就是接口定义规范是什么的详细内容，更多请关注0133技术站其它相关文章！
