登录 注册

restful参数规则讨论

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

关于 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 回帖
  • 参数
    6 引用 • 45 回帖
  • 合法性
    1 引用 • 28 回帖
  • 时间戳
    1 引用 • 28 回帖
大连 位置
1 收藏
2 赞同
28 回帖
11
9
4
8.5k 28 438 2.3k 1.4k 773 33 577 2.9k

相关帖子

28 回帖
restful参数规则讨论

欢迎来到这里！

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

注册 关于
请输入回帖内容 ...
  • 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 木已成舟了，只能慢慢改了....

  • Vanessa •
    订阅者 付费者

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

  • 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 嗯多谢分享~

请输入回帖内容 ...
crick77
天行健 男儿当立志 大连
回帖
327
 帖子
123
 积分
7608

近期热议

推荐标签 标签

  • Unity

    Unity 是由 Unity Technologies 开发的一个让开发者可以轻松创建诸如 2D、3D 多平台的综合型游戏开发工具，是一个全面整合的专业游戏引擎。

    25 引用 • 7 回帖 • 233 关注
  • jQuery

    jQuery 是一套跨浏览器的 JavaScript 库，强化 HTML 与 JavaScript 之间的操作。由 John Resig 在 2006 年 1 月的 BarCamp NYC 上释出第一个版本。全球约有 28% 的网站使用 jQuery，是非常受欢迎的 JavaScript 库。

    63 引用 • 134 回帖 • 732 关注
  • 面试

    面试造航母，上班拧螺丝。多面试，少加班。

    324 引用 • 1395 回帖 • 4 关注
  • Mobi.css

    Mobi.css is a lightweight, flexible CSS framework that focus on mobile.

    1 引用 • 6 回帖 • 708 关注
  • 旅游

    希望你我能在旅途中找到人生的下一站。

    86 引用 • 896 回帖 • 1 关注
  • C++

    C++ 是在 C 语言的基础上开发的一种通用编程语言，应用广泛。C++ 支持多种编程范式，面向对象编程、泛型编程和过程化编程。

    106 引用 • 152 回帖
  • BAE

    百度应用引擎（Baidu App Engine）提供了 PHP、Java、Python 的执行环境，以及云存储、消息服务、云数据库等全面的云服务。它可以让开发者实现自动地部署和管理应用，并且提供动态扩容和负载均衡的运行环境，让开发者不用考虑高成本的运维工作，只需专注于业务逻辑，大大降低了开发者学习和迁移的成本。

    19 引用 • 75 回帖 • 618 关注
  • 单点登录

    单点登录（Single Sign On）是目前比较流行的企业业务整合的解决方案之一。SSO 的定义是在多个应用系统中，用户只需要登录一次就可以访问所有相互信任的应用系统。

    9 引用 • 25 回帖
  • WebComponents

    Web Components 是 W3C 定义的标准，它给了前端开发者扩展浏览器标签的能力，可以方便地定制可复用组件，更好的进行模块化开发，解放了前端开发者的生产力。

    1 引用 • 15 关注
  • Webswing

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

    1 引用 • 15 回帖 • 632 关注
  • MyBatis

    MyBatis 本是 Apache 软件基金会 的一个开源项目 iBatis，2010 年这个项目由 Apache 软件基金会迁移到了 google code，并且改名为 MyBatis ，2013 年 11 月再次迁移到了 GitHub。

    170 引用 • 414 回帖 • 405 关注
  • 游戏

    沉迷游戏伤身，强撸灰飞烟灭。

    171 引用 • 813 回帖 • 1 关注
  • DNSPod

    DNSPod 建立于 2006 年 3 月份，是一款免费智能 DNS 产品。 DNSPod 可以为同时有电信、网通、教育网服务器的网站提供智能的解析，让电信用户访问电信的服务器，网通的用户访问网通的服务器，教育网的用户访问教育网的服务器，达到互联互通的效果。

    6 引用 • 26 回帖 • 524 关注
  • Docker

    Docker 是一个开源的应用容器引擎，让开发者可以打包他们的应用以及依赖包到一个可移植的容器中，然后发布到任何流行的操作系统上。容器完全使用沙箱机制，几乎没有性能开销，可以很容易地在机器和数据中心中运行。

    484 引用 • 906 回帖 • 1 关注
  • 新人

    让我们欢迎这对新人。哦，不好意思说错了，让我们欢迎这位新人！
    新手上路，请谨慎驾驶！

    51 引用 • 226 回帖
  • ngrok

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

    7 引用 • 63 回帖 • 605 关注
  • FFmpeg

    FFmpeg 是一套可以用来记录、转换数字音频、视频，并能将其转化为流的开源计算机程序。

    23 引用 • 31 回帖 • 8 关注
  • 996

    “工作 996， 生病 ICU”

    13 引用 • 200 回帖 • 2 关注
  • 程序员

    程序员是从事程序开发、程序维护的专业人员。

    541 引用 • 3529 回帖
  • InfluxDB

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

    2 引用 • 60 关注
  • Mac

    Mac 是苹果公司自 1984 年起以“Macintosh”开始开发的个人消费型计算机，如：iMac、Mac mini、Macbook Air、Macbook Pro、Macbook、Mac Pro 等计算机。

    164 引用 • 594 回帖 • 2 关注
  • B3log

    B3log 是一个开源组织，名字来源于“Bulletin Board Blog”缩写，目标是将独立博客与论坛结合，形成一种新的网络社区体验，详细请看 B3log 构思。目前 B3log 已经开源了多款产品：Sym、Solo、Vditor 和 思源笔记。

    1083 引用 • 3461 回帖 • 262 关注
  • frp

    frp 是一个可用于内网穿透的高性能的反向代理应用，支持 TCP、UDP、 HTTP 和 HTTPS 协议。

    16 引用 • 7 回帖
  • 微软

    微软是一家美国跨国科技公司，也是世界 PC 软件开发的先导，由比尔·盖茨与保罗·艾伦创办于 1975 年，公司总部设立在华盛顿州的雷德蒙德（Redmond，邻近西雅图）。以研发、制造、授权和提供广泛的电脑软件服务业务为主。

    8 引用 • 44 回帖
  • LeetCode

    LeetCode（力扣）是一个全球极客挚爱的高质量技术成长平台，想要学习和提升专业能力从这里开始，充足技术干货等你来啃，轻松拿下 Dream Offer！

    209 引用 • 72 回帖
  • C

    C 语言是一门通用计算机编程语言，应用广泛。C 语言的设计目标是提供一种能以简易的方式编译、处理低级存储器、产生少量的机器码以及不需要任何运行环境支持便能运行的编程语言。

    83 引用 • 165 回帖 • 11 关注
  • Sphinx

    Sphinx 是一个基于 SQL 的全文检索引擎，可以结合 MySQL、PostgreSQL 做全文搜索，它可以提供比数据库本身更专业的搜索功能，使得应用程序更容易实现专业化的全文检索。

    1 引用 • 191 关注

最新标签