Restful接口设计介绍及项目准备工作

---

Restful接口设计

存在原因

Web２.０阶段的到来，客户端不仅仅是ｐｃ端，可能是移动ａｐｐ、也可能是小程序，这就要求提供一套统一的API接口，不同类型的客户端基于相同的协议/规则来调用该API接口并获取预期的数据。
不同的开发者对API设计习惯不同，可能会出现
新增员工：

http://localhost/employee/save
http://localhost/employee/add
http://localhost/employee/new
http://localhost/employee/xinzeng
http://localhost/employee/append
1
2
3
4
5

所以具有Restful风格的API接口就出现了

Restful风格

REST 是一种设计 API 接口规则（风格），因其具有简单、易读、易用的特点，在 web 项目中非常受欢迎，在设计接口时，如果满足 res 的柬条件和源则的应用程序或设计就称其为 RESTful 应用。

传统接口设计

考虑点：

1. 请求路径：见名知意
2. 请求方式：传统模式会忽略（@Request Mapping不管是什么方式都会传入）
3. 请求参数：由需求决定
4. 请求的响应：模板路径/由需求决定

RESTful接口设计

考虑点：

1.请求路径：由当前接口操作的资源决定，一般使用所操作资源的复数作为资源的路径 再RESTful眼中，一切皆资源，每个资源都有一个唯一的资源定位符（URL）

2.请求方式： 传统接口设计方式，使用见名知意设计路径，可以从路径上看出接口对资源操作，而 RESTful 风格接口使用资源复数作为路径，就无法从路径上看出接口对资源操作，那该怎么办？

RESTful 风格在 HTTP 请求方法上做文章，约定：

• GET ( SELECT )：从服务器取出资源（一项或多项）。
• POST ( CREATE )：在服务器新建一个资源。
• PUT ( UPDATE )：在服务器更新资源（客户端提供改变后的完整资源）。 PUT 更新整个对象
• PATCH ( UPDATE)：在服务器更新资源（客户端提供改变的属性【补丁】)。 PATCH 更新个别属性
• DELETE ( DELETE)：从服务器删除资源。

了解
HEAD ：获得一个资源的元数据，比如一个资源的 hash 值或者最后修改日期；
OPTIONS ：获得客户端针对一个资源能够实施的操作：（获取该资源的 api 能够对资源做什么操作的描述）

传统的路径见名知意＝ RESTful 路径＋请求方式

3.请求参数：和传统一样由需求决定

4.请求响应：以公司要求/需求为主，响应数据格式是json格式

http响应状态码

补充

RESTful框架

常用的有Spring MVC , jersey, play

API测试工具

Postman, Insomnia

RESTful 接口练习

项目准备

构建一个标准的Spring boot项目，使用web环境

1.引入依赖

<parent>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-parentartifactId>
    <version>2.4.3version>
    <relativePath/>
  parent>

  <dependencies>
    <dependency>
      <groupId>org.springframework.bootgroupId>
      <artifactId>spring-boot-starter-webartifactId>
    dependency>
    <dependency>
      <groupId>org.projectlombokgroupId>
      <artifactId>lombokartifactId>
      <version>1.18.20version>
      <scope>providedscope>
    dependency>
  dependencies>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

2.在resources下创建application.properties

server.port=80
1

3.编辑实体类、启动类、controller类

实体类

在域名反写的下面再建一个Java文件，直接domian.Employee

package org.chad.domain;

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
public class Employee {
    private Long id;
    private String name;
    private int age;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

启动类

在域名反写的下面再建一个Java文件，名为App

package org.chad;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class,args);
    }
}
1
2
3
4
5
6
7
8
9
10
11

controller类

在域名的包下面建Java文件，controller.EmployeeController

package org.chad.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * 员工的对外接口声明类
 * 员工的控制层/表现层
 */
@Controller
public class EmployeeController {
    @RequestMapping("/hello")
    @ResponseBody
    public String hello(){
        return "ok";
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

打开浏览器

访问 local host：80/hello

成功的访问了

创作不易点个赞，精彩内容下节继续