RESTful API 设计规范

前言

RESTful API是一种互联网应用程序的API设计理念：URL定位资源，用HTTP动词（GET,POST,DELETE,DETC）描述操作。

一、基本要求

1、URL地址中只包含名词，表示资源

2、使用http动词表示动作,进行操作资源。

二、HTTP动词

1、常用的HTTP动词有下面五个

（1）GET（SELECT）：从服务器取出资源（一项或多项）。

（2）POST（CREATE）：在服务器新建一个资源。

（3）PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。

（4）PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。

（5）DELETE（DELETE）：从服务器删除资源。

更新使用PUT就可以。

2、java代码使用

（1）@GetMapping

（2）@PostMapping

（4）@PutMapping

（3）@DeleteMapping

三、示例

错误示例                       ——》   正确示例

POST  /getAllNews       ——》   GET   /news或者/news/list    获取所有

POST  /getNewsById    ——》   GET  /news/newsid  获取单个，此时id使用路径参数

Java使用@PathVariable注解接收路径参数，例子：

	@GetMapping("/news/{newsId}")
	public ResultBO<Object> getNewsById(@PathVariable("newsId") Integer newsId)throws Exception{
		
		NewsDO newsDO = newsService.getByPrimaryKey(newsId);
		if (Objects.equals(newsDO, null)) {
			return ResultTool.error(LwqExceptionEnum.NO_NEWS);
		}
		return ResultTool.success(newsDO);
	}

pageNum、pageSize以及其他普通参数，使用@RequestParam即可。