Restful API 学习之旅

最新推荐文章于 2022-03-08 21:43:20 发布

0爪哇人0

最新推荐文章于 2022-03-08 21:43:20 发布

阅读量264

点赞数

分类专栏： java后端开发文章标签： Rest API springboot postman

本文链接：https://blog.csdn.net/qq_34745295/article/details/88927313

版权

java后端开发专栏收录该内容

3 篇文章 0 订阅

订阅专栏

长期以来，软件研究主要关注软件设计的分类、设计方法的演化，很少客观地评估不同的设计选择对系统行为的影响。而相反地，网络研究主要关注系统之间通信行为的细节、如何改进特定通信机制的表现，常常忽视了一个事实，那就是改变应用程序的互动风格比改变互动协议，对整体表现有更大的影响。RESTful API的提出就是想要在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、适宜通信的架构。

一、什么是REST

REST，即Representational State Transfer的缩写。这个词组的翻译是"表现层状态转化。

1.资源 “表现层"其实指的是"资源”（Resources）的"表现层"。所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。
2.表现层 “资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式，叫做它的 “表层”（Representation）。比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。URI只代表资源的实体，不代表它的形式。严格地说，有些网址最后的”.html"后缀名是不必要的，因为这个后缀名表示格式，属于"表现层"范畴，而URI应该只代表"资源"的位置。它的具体表现形式，应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对"表现层"的描述。
3.状态转化访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态的变化。互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"（StateTransfer）。而这种转化是建立在表现层之上的，所以就是"表现层状态转化"。客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。
REST小结
Resource：资源，即数据。
Representational：某种表现形式，比如用JSON，XML，JPEG等；
State Transfer：状态变化。通过HTTP动词实现。

二、怎样开发RESTful API

RESTful API就是指REST风格的API，是一套来规范多种形式的前端和同一个后台的交互方式的协议，主要是为了在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、适宜通信的架构。

RESTful API有一套设计原则，具体参考《RESTful API设计指南》，大致为一下几点：
协议：API与用户的通信协议，总是使用HTTPs协议。
域名：应该尽量将API部署在专用域名之下。如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

  https://api.github.com/
  https://github.com/api

版本：应该将API的版本号放入URL。（有些文献表示不需要版本信息，版本号可以在HTTP请求头信息的Accept字段中进行区分，应参加相应的编程开发规范）
路径：路径又称"终点"（endpoint），表示API的具体网址。
HTTP动词：对于资源的具体操作类型，由HTTP动词表示。

GET（SELECT）：从服务器取出资源（一项或多项）。    
POST（CREATE）：在服务器新建一个资源。       
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。       
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。    
DELETE（DELETE）：从服务器删除资源。
HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

过滤信息：如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

?limit=10：指定返回记录的数量 ?offset=10：指定返回记录的开始位置。   
   ?page=2&per_page=100：指定第几页，以及每页的记录数。   
   ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。   
   ?animal_type_id=1：指定筛选条件

状态码：服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

错误处理：如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

{
    error: "Invalid API key"
}

返回结果：针对不同操作，服务器向用户返回的结果应该符合以下规范。

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

Hypermedia API ：RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

例子：https://api.github.com/

其他：API的身份认证应该使用OAuth 2.0框架。服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

三、使用spring boot设计RESTful API

spring boot 安装

spring boot demon生成方法，网址为https://start.spring.io/#

spring boot 快速生成demo方法

导入到eclipse或idea中，import->Exiting maven project

导入maven工程

安装相应插件，run as - > maven install
安装完成之后就可以进行RESTful API设计开发了。

RESTful API 正式开发

spring boot结构：

DemoApplication.java为启动文件，运行该文件启动spring boot工程；

pom.xml为maven配置文件，用于配置依赖包等；
application.yml spring boot配置文件
在这里插入图片描述
application.yml配置文件

 spring:
   jackson:
     date-format: yyyy-MM-dd-hh-mm-ss  #时间输出方式
     timezone: GMT+8
     serialization:
       write-dates-as-timestamps: false
       
       
 logging:
   file: target/app.log		#日志输出配置
   level:
     ROOT: WARN
     cn.devmgr: TRACE

热部署devtools：
就是容器状态在运行的情况下部署或者重新部署整个项目，在这种情况下一般整个内存会清空,重新加载.简单来说就是Tomcat或者其他的web服务器会帮我们重新加载项目。这种方式可能会造成session丢失等情况。

pom.xml依赖
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-devtools</artifactId>
	<optional>true</optional>
</dependency>

自动build
在这里插入图片描述

Restful API 代码实现

资源类声明：

@RestController
@RequestMapping("/micro")
public class microController {

}

获取所有用户信息（为了快速学习Restful API编程规则，暂时不涉及数据库操作）

@GetMapping
public List<MicroUser>getAll(){
	List<MicroUser>  list = new ArrayList<>();
	list.add(new MicroUser());
	return list;
}

获取指定id的用户信息

@GetMapping("/{id}")
public MicroUser getOne(@PathVariable Integer id){
	if(id!=null){
		return new MicroUser(id,"JavaMan","1505121114",1,22,"","",20,"");
	}
	return null;
}

插入用户信息

@PostMapping
public MicroUser insertOne(@RequestBody MicroUser microUser){
	if(microUser!=null){
		microUser.setId(999);
		return microUser;
	}
	return null;
}

根据id，更新指定的用户信息

@PutMapping("/{id}")
public MicroUser updateOne(@PathVariable Integer id,@RequestBody MicroUser microUser){
	if(id!=null){
		return microUser;
	}
	return null;
}

删除指定id的用户信息

@DeleteMapping("/{id}")
public Map<String,String> deleteOne(@PathVariable Integer id, HttpServletRequest request,
		@RequestParam(value="delete_reason",required=false) String delete_reason)throws Exception{
	Map<String,String> result = new HashMap<>();
	if(id!=null){
		result.put("message", id+"被"+request.getRemoteAddr()+"删除，原因："+delete_reason);
		return result;
	}
	return null;		
}

上传指定id的图片文件

@PostMapping(value="/{id}/photos",consumes=MediaType.MULTIPART_FORM_DATA_VALUE)
public void addPhoto(@PathVariable Integer id,@RequestParam("photo") MultipartFile imgFile) throws Exception{
	//上传文件，保存文件
	FileOutputStream fos = new FileOutputStream("target/photos/"+imgFile.getOriginalFilename());
	IOUtils.copy(imgFile.getInputStream(), fos);
	System.out.println("ok");
	fos.close();
}

下载指定id的图片文件

@GetMapping(value="/{id}/photos",produces=MediaType.IMAGE_JPEG_VALUE)
public byte[] getPhoto(@PathVariable Integer id)throws Exception{
	String photoFile = "target/photos/3.jpg";
	System.out.println("ok1");
	InputStream is = new FileInputStream(photoFile);
	
	return IOUtil.toByteArray(is);
}

工具类

public class IOUtil {
	public static byte[] toByteArray(InputStream input) throws IOException {
	    ByteArrayOutputStream output = new ByteArrayOutputStream();
	    byte[] buffer = new byte[4096];
	    int n = 0;
	    while (-1 != (n = input.read(buffer))) {
	        output.write(buffer, 0, n);
	    }
	    return output.toByteArray();
	}
	
}

PostMan测试Restful API

部分测试如下所示：

get
获取所有用户信息
在这里插入图片描述
下载图片

post
添加用户信息

上传文件

四、总结

RESTful由于其面向资源接口设计以及操作抽象简化了开发者的不良设计，同时也最大限度的利用了HTTP最初的应用协议设计理念。
RESTful对于资源型服务接口来说很合适，同时特别合适对于效率很高，但是对于安全要求不高的场景。
Restful API编写规范，提供了一个功能强、性能好、适宜通信的架构，适合各行业交互使用。
代码资源：整理中，待上传。。。

0爪哇人0

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Restful API 学习之旅

长期以来，软件研究主要关注软件设计的分类、设计方法的演化，很少客观地评估不同的设计选择对系统行为的影响。而相反地，网络研究主要关注系统之间通信行为的细节、如何改进特定通信机制的表现，常常忽视了一个事实，那就是改变应用程序的互动风格比改变互动协议，对整体表现有更大的影响。RESTful API的提出就是想要在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、...
复制链接

扫一扫

专栏目录