无规矩不成方圆，聊一聊 Spring Boot 中 RESTful 接口设计规范(二）-阿里云开发者社区

无规矩不成方圆，聊一聊 Spring Boot 中 RESTful 接口设计规范(二）

2022-09-06 177

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： 无规矩不成方圆，聊一聊 Spring Boot 中 RESTful 接口设计规范(二）

三实例

（一）定义统一参数
（二）定义接口授权类别
（三）用户接口
（四）用户登录

三实例

假设存在这样一个一个业务：一个ERP系统，需要提供两个接口，一个是用户访问接口(需要验证)，另一个是用户注册接口(不需要验证)。

根据本篇文章一，二部分的建议，我们来设计满足该业务需求的接口

（一）定义统一参数

1.定义统一输入参数

微信图片_20220906171558.png

2.定义统一输出参数

微信图片_20220906171653.png

3.定义统一错误码

微信图片_20220906171714.png

（二）定义接口授权类别

如下为定义接口授权类别

微信图片_20220906171744.png

（三）用户接口

1.用户注册

微信图片_20220906171752.png

2.Request

微信图片_20220906171832.png

3.Responce

微信图片_20220906171838.png

4.code示例

Request:
{
    "mobile":13636595499,
    "verify_code":"987654",
    "pwd":"123456"
}
Responce:
(1)error
{
   "status":0,
   "error_code":1001，
   "error_desc":"手机验证码已失效"
}
(2)succed
{
   "sid":"sh201901141529",
   "uid":1,
   "status":1
}

（四）用户登录

1.登录接口概述

微信图片_20220906171909.png

2.Request

微信图片_20220906171936.png

3.Responce

微信图片_20220906172003.png

4.Code

Responce:
1.error
{
   "status":0,
   "error_code":1002,
   "error_desc":"密码错误"
}
2.succeed
{
   "sid":"sh201901141529",
   "user":{
         "id":1,
     "username":"",
      age:0,
      gender:0
   },
   "status":1
}

无规矩不成方圆，聊一聊 Spring Boot 中 RESTful 接口设计规范(二）