restful参数规则讨论

本贴最后更新于 3176 天前,其中的信息可能已经天翻地覆

关于 restful 参数规则 哪种比较合理?

返回值:

  1. code:200,message:"succ", id:"12", name:"course12"
  2. code:200,message:"succ", data:{id:"12", name:"course12"}

入参:

  1. token:"123456", id:"12", name:"course12"
  2. token:"123456", data:{id:"12", name:"course12"}

如果做合法性验证??

以及是否增加时间戳验证??

我之前做了时间戳 遇到的比较坑的事是 客户端(手机)的时间不准。。调了系统时间导致 app 没数据了。。。

合法性验证 之前做的 是把所有参数 进行 SHA-1 签名 然后服务端验证参数是否被串改

再补充一个问题

关于接口版本控制,你们是放在 path 里 还是 参数 params 里?

我觉得 path 里直观 @PathVariable, 但是不合法就直接被 spring 返回了

如果放到参数里,可以增加更多控制操作

  • RESTful

    一种软件架构设计风格而不是标准,提供了一组设计原则和约束条件,主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。

    30 引用 • 114 回帖 • 3 关注
  • 参数
    6 引用 • 45 回帖
  • 合法性
    1 引用 • 28 回帖
  • 时间戳
    1 引用 • 28 回帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • zempty

    社区巡逻队日常巡检,楼主你好!楼主再见!🚜🚜🚜

  • 88250

    ####返回值

    • HTTP Status Code 最好只是用来做特殊的场景,比如 401、403、404 等,建议统一返回 200,见下一条
    • 一般正常情况都返回 [HTTP] 200,业务是否正常通过一个 bool 型 flag 进行判断,并带上 errorcode 作为业务错误返回码,正常业务返回 0
    • 数据段使用 data 一个字段统一封装,方便客户端解析 (看不懂你上面 name="course12" 这个结构,不是 JSON 吧)

    ####合法性校验

    • 客户端请求时使用私钥 app-secret、一个随机数 rand 、时间戳 timestamp 生成哈希出(可用 SHA1)一个签名 signature,然后在 HTTP 头里带上:
      • 应用标识 app-key
      • rand
      • timestamp
      • signature
    • 服务端接收到这些信息后通过 app-key 查库找到 secret,并按照客户端的哈希算法计算签名是否正确,如果和发送过来的签名一致,就继续业务处理
    • 服务端业务处理后,返回:
      • rand
      • timestamp
      • signature
        这三个参数给客户端,客户端再次按照一开始的逻辑计算 signature,然后和服务端带过来的 signature 做对比,如果一样就说明 OK

    基本的校验思路就是这样,另外,一定要走 [HTTPS] 。

    ####版本

    我个人偏向在 path 里面带版本号,一些 [RESTFul] 、HTTP API 最佳实践的文章里也推荐这个做法,好处是:

    • 版本固化,客户端不宜出错
    • 服务端版本分明,天然的路由控制

    以上。

    PS 记得给我感谢 😆

  • crick77
    作者

    @88250

    返回值

    • 统一返回 200 是正确的 可以确认是否连接到接口处理
    • code 不建议使用 bool,不推荐 0,因为 int 默认是 0,boolean 有些语言 也会对 0 有默认,所以如果是 int 建议使用 1、2,更推荐 String,没有歧义,最近遇到的一个问题是 int 经过 json 转换之后变成了 double (1 变成了 1.0)
    • 是把返回的业务参数和 系统参数(状态 code,描述 message)等放在一个 map 中进行 json 转换,写错了 是 name:"course12"

    版本

    “服务端版本分明,天然的路由控制” 是说

    @RequestMapping(value={"/api/v1/bag/add"})

    而不是

    @RequestMapping(value={"/api/{versiokn}/bag/add"})

    ??

    合法性这个我再看一遍 不过我说的时间戳的坑 你一般把时间戳校验多长时间,我遇到过太多次 手机时间不准的 ,如果时间校验期限是几天的话 觉得也没有什么意义了

  • zonghua

    Spring MVC 不支持组路由

    1460380783612

    你们每个 url 都要写一个版本的参数

  • crick77
    作者

    @zonghua

    @Controller
    @RequestMapping("/api/{version}/bag")
    public class BagApi extends BaseApiController {
    
    	@Autowired
    	private IBagService bagService;
    
    	@RequestMapping(value={"/add"})
    	
    

    是不是不太好?

  • crick77
    作者

    @88250

    还有一个坑 就是中文签名 iOS 和 android 两种的编码不一样

  • zonghua

    @crick77 可以这样写的咩?version 这个参数注入到哪里了?

  • 88250

    @crick77

    • 成功标识是 bool,errorcode 是 int
    • 版本那个是的,服务端路由配置写死,不要动态
    • 其实我们没校验时间戳,因为你说的问题....
  • zonghua

    @88250 写死?然后有前端的 Nginx 进行 URL 重写?

  • zonghua

    不同版本的服务在不同服务器?

  • 88250 1

    @zonghua path 写死就固化了版本啊,不同版本不同实现,清晰明了

  • crick77
    作者

    @zonghua
    public ModelAndView add(@PathVariable String version, @Valid BagDomainPo bag, BindingResult result

  • crick77
    作者

    @88250

    还是觉得 bool 不太好,不同语言标准不一样了, 还是 String 最稳妥
    版本这个写死我觉得对, 虽然现在是动态的 + enum+switch 但我觉得 动态的话和 params 一样了 没有什么优势
    时间戳去掉吧。。。再追问一个,如果前后台分离 我想在 html 里也调用 api,那么 你怎么做这个 app-secret

  • 88250

    @crick77

    • 成功标识和 msg 要分开啊
    • 那就加 token 吧,用 secret 生成一个 token,然后再校验
  • crick77
    作者

    @88250 各种疑问都问了吧
    restful 你怎么做单元?
    看一下我现在写的? 不知道为什么会报错

    public class BagApiTest extends BaseUnitTest {
    
    	@Autowired
    	private BagApi bagApi;
    
    	@Autowired
    	private RequestMappingHandlerAdapter handlerAdapter;
    	private MockHttpServletRequest request;
    	private MockHttpServletResponse response;
    
    	@Before
    	public void setUp() {
    		request = new MockHttpServletRequest();
    		response = new MockHttpServletResponse();
    	}
    
    	@Test
    	public void addTest() throws Exception{
    		request.setRequestURI("/api/1/bag/add.do");  
    		request.setMethod("POST");  
    		Map<String, Object> params = new HashMap<String, Object>();
    		request.addParameters(params);
    
    		// 执行URI对应的action    
    		ModelAndView mv = handlerAdapter.handle(request, response, new HandlerMethod(bagApi, "add"));  
    		Map<String,Object> result = mv.getModel();
    		System.out.println(result);
    	}
    }
    

    BaseUnitTest 里加载 app-context.xml 等环境信息 现在报的错误是

    java.lang.NoSuchMethodException: wang.crick.jdtc.webservices.bag.BagApi.add()

  • 88250

    @crick77 用 Spring 和测试套件整合的方式,具体我不记得了,你加油

  • crick77 1
    作者

    @88250

    • 是分开的, 成功标识是 “1”or “2” , msg 是信息
    • 我现在的想法是用 jedis 作一个模拟的 session 管理,生成 token 把用户信息存起来
  • crick77
    作者

    @88250
    等我调通了把代码放出来, spring 不同版本的差别现在已经这么大了么。。。。

    还想做接口调用次数及 ip 记录 和 可视化的 web 端接口模拟参数调试

    看看我这一个月的通宵能做出来多少吧

  • 88250

    @crick77 加油加油,注意休息哈~

  • crick77
    作者

    @88250

    报错是因为 HandlerMethod 没有指定入参类型
    指定之后 因为参数有 @PathVariable 所以报错, 解决方法正在查找

    在思考 是通过 http 请求的方式单元测试 还是通过反射机制

  • 88250

    @crick77 最好是发 HTTP 请求,这样测试路径比较真实

  • muyuballs 1

    @88250 社区的接口也应该参考一下 restful 吧 ~~

  • 88250

    @Qiao 木已成舟了,只能慢慢改了....

  • 楼主科普下呗,不用又忘记了

  • yangyujiao

    貌似我们是第二种吧。。

  • crick77
    作者

    @yangyujiao 入参第一种 返回第二种 这样比较靠谱

  • crick77 1
    作者

    @88250
    调通了 之前是 spring3.1 利用 RequestMappingHandlerAdapter 通过反射 测试方法
    现在是 3.2.9 通过 MockMvc 模拟方法测试 MockMvc 开头的这几个类 封装的方法不错 够用了 测试用例完善一下 就可以赶赶任务了
    测试有时间的话 再写一篇 挺有意思的 4.0 之后的测试更简单

    public class BagApiTest extends BaseUnitTest {
    
    	@Autowired
    	private WebApplicationContext wac;
    
    	private MockMvc mockMvc;
    
    	@Before
    	public void setup() {
    		this.mockMvc = MockMvcBuilders.webAppContextSetup(this.wac).build();
    	}
    
    	@Test
    	public void addTest() throws Exception {
    
    		MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders.post("/api/1/bag/add.do");
    		requestBuilder.param("specId", GuidKeyGenerator.getUUIDKey());
    
    		ResultActions result = mockMvc.perform(requestBuilder);
    
    		MvcResult mvc = result.andExpect(MockMvcResultMatchers.status().isOk())
    //				.andDo(MockMvcResultMatchers.print())
    				.andReturn();
    
    		Map<String, Object> resultMap = mvc.getModelAndView().getModel();
    	}
    }
    
  • 88250

    @crick77 嗯多谢分享~

请输入回帖内容 ...

推荐标签 标签

  • 生活

    生活是指人类生存过程中的各项活动的总和,范畴较广,一般指为幸福的意义而存在。生活实际上是对人生的一种诠释。生活包括人类在社会中与自己息息相关的日常活动和心理影射。

    230 引用 • 1454 回帖 • 1 关注
  • 音乐

    你听到信仰的声音了么?

    61 引用 • 511 回帖
  • CSDN

    CSDN (Chinese Software Developer Network) 创立于 1999 年,是中国的 IT 社区和服务平台,为中国的软件开发者和 IT 从业者提供知识传播、职业发展、软件开发等全生命周期服务,满足他们在职业发展中学习及共享知识和信息、建立职业发展社交圈、通过软件开发实现技术商业化等刚性需求。

    14 引用 • 155 回帖
  • danl
    146 关注
  • ngrok

    ngrok 是一个反向代理,通过在公共的端点和本地运行的 Web 服务器之间建立一个安全的通道。

    7 引用 • 63 回帖 • 627 关注
  • 锤子科技

    锤子科技(Smartisan)成立于 2012 年 5 月,是一家制造移动互联网终端设备的公司,公司的使命是用完美主义的工匠精神,打造用户体验一流的数码消费类产品(智能手机为主),改善人们的生活质量。

    4 引用 • 31 回帖
  • 域名

    域名(Domain Name),简称域名、网域,是由一串用点分隔的名字组成的 Internet 上某一台计算机或计算机组的名称,用于在数据传输时标识计算机的电子方位(有时也指地理位置)。

    43 引用 • 208 回帖
  • Kafka

    Kafka 是一种高吞吐量的分布式发布订阅消息系统,它可以处理消费者规模的网站中的所有动作流数据。 这种动作(网页浏览,搜索和其他用户的行动)是现代系统中许多功能的基础。 这些数据通常是由于吞吐量的要求而通过处理日志和日志聚合来解决。

    36 引用 • 35 回帖
  • Bug

    Bug 本意是指臭虫、缺陷、损坏、犯贫、窃听器、小虫等。现在人们把在程序中一些缺陷或问题统称为 bug(漏洞)。

    76 引用 • 1737 回帖
  • Tomcat

    Tomcat 最早是由 Sun Microsystems 开发的一个 Servlet 容器,在 1999 年被捐献给 ASF(Apache Software Foundation),隶属于 Jakarta 项目,现在已经独立为一个顶级项目。Tomcat 主要实现了 JavaEE 中的 Servlet、JSP 规范,同时也提供 HTTP 服务,是市场上非常流行的 Java Web 容器。

    162 引用 • 529 回帖 • 4 关注
  • Bootstrap

    Bootstrap 是 Twitter 推出的一个用于前端开发的开源工具包。它由 Twitter 的设计师 Mark Otto 和 Jacob Thornton 合作开发,是一个 CSS / HTML 框架。

    18 引用 • 33 回帖 • 667 关注
  • Webswing

    Webswing 是一个能将任何 Swing 应用通过纯 HTML5 运行在浏览器中的 Web 服务器,详细介绍请看 将 Java Swing 应用变成 Web 应用

    1 引用 • 15 回帖 • 637 关注
  • Gzip

    gzip (GNU zip)是 GNU 自由软件的文件压缩程序。我们在 Linux 中经常会用到后缀为 .gz 的文件,它们就是 Gzip 格式的。现今已经成为互联网上使用非常普遍的一种数据压缩格式,或者说一种文件格式。

    9 引用 • 12 回帖 • 147 关注
  • 智能合约

    智能合约(Smart contract)是一种旨在以信息化方式传播、验证或执行合同的计算机协议。智能合约允许在没有第三方的情况下进行可信交易,这些交易可追踪且不可逆转。智能合约概念于 1994 年由 Nick Szabo 首次提出。

    1 引用 • 11 回帖 • 2 关注
  • 阿里巴巴

    阿里巴巴网络技术有限公司(简称:阿里巴巴集团)是以曾担任英语教师的马云为首的 18 人,于 1999 年在中国杭州创立,他们相信互联网能够创造公平的竞争环境,让小企业通过创新与科技扩展业务,并在参与国内或全球市场竞争时处于更有利的位置。

    43 引用 • 221 回帖 • 106 关注
  • TextBundle

    TextBundle 文件格式旨在应用程序之间交换 Markdown 或 Fountain 之类的纯文本文件时,提供更无缝的用户体验。

    1 引用 • 2 回帖 • 53 关注
  • OkHttp

    OkHttp 是一款 HTTP & HTTP/2 客户端库,专为 Android 和 Java 应用打造。

    16 引用 • 6 回帖 • 76 关注
  • 百度

    百度(Nasdaq:BIDU)是全球最大的中文搜索引擎、最大的中文网站。2000 年 1 月由李彦宏创立于北京中关村,致力于向人们提供“简单,可依赖”的信息获取方式。“百度”二字源于中国宋朝词人辛弃疾的《青玉案·元夕》词句“众里寻他千百度”,象征着百度对中文信息检索技术的执著追求。

    63 引用 • 785 回帖 • 164 关注
  • Oracle

    Oracle(甲骨文)公司,全称甲骨文股份有限公司(甲骨文软件系统有限公司),是全球最大的企业级软件公司,总部位于美国加利福尼亚州的红木滩。1989 年正式进入中国市场。2013 年,甲骨文已超越 IBM,成为继 Microsoft 后全球第二大软件公司。

    105 引用 • 127 回帖 • 370 关注
  • Lute

    Lute 是一款结构化的 Markdown 引擎,支持 Go 和 JavaScript。

    26 引用 • 196 回帖 • 17 关注
  • 创造

    你创造的作品可能会帮助到很多人,如果是开源项目的话就更赞了!

    178 引用 • 997 回帖
  • QQ

    1999 年 2 月腾讯正式推出“腾讯 QQ”,在线用户由 1999 年的 2 人(马化腾和张志东)到现在已经发展到上亿用户了,在线人数超过一亿,是目前使用最广泛的聊天软件之一。

    45 引用 • 557 回帖 • 44 关注
  • JRebel

    JRebel 是一款 Java 虚拟机插件,它使得 Java 程序员能在不进行重部署的情况下,即时看到代码的改变对一个应用程序带来的影响。

    26 引用 • 78 回帖 • 672 关注
  • RIP

    愿逝者安息!

    8 引用 • 92 回帖 • 363 关注
  • InfluxDB

    InfluxDB 是一个开源的没有外部依赖的时间序列数据库。适用于记录度量,事件及实时分析。

    2 引用 • 76 关注
  • Angular

    AngularAngularJS 的新版本。

    26 引用 • 66 回帖 • 536 关注
  • OnlyOffice
    4 引用 • 3 关注