0

0

java怎么实现RESTful API 手把手教你搭建RESTful风格的接口服务

星降

星降

发布时间:2025-11-06 23:47:02

|

1282人浏览过

|

来源于php中文网

原创

使用spring boot创建restful api,通过定义user实体和usercontroller实现增删改查,以内存数据模拟服务,结合http动词完成接口设计,快速构建可测试的web服务。

java怎么实现restful api 手把手教你搭建restful风格的接口服务

实现一个RESTful API服务,Java中最常见的方式是使用Spring Boot框架。它简化了配置和开发流程,能快速搭建出符合REST规范的接口服务。下面手把手带你从零开始创建一个基础但完整的RESTful接口。

1. 准备开发环境

确保你具备以下工具

  • JDK 8 或更高版本
  • Maven(用于依赖管理)
  • IDE(如 IntelliJ IDEA 或 Eclipse)
  • 浏览器或 Postman(用于测试接口)

2. 创建Spring Boot项目

访问 https://www.php.cn/link/5ecc613150de01b7e6824594426f24f4,填写以下信息:

  • Project: Maven
  • Language: Java
  • Spring Boot 版本:选择最新稳定版(如 3.x)
  • Group: com.example
  • Artifact: demo-api

在“Dependencies”中添加:

立即学习Java免费学习笔记(深入)”;

  • Spring Web

点击“Generate”下载压缩包,解压后导入到你的IDE中。

3. 理解RESTful设计原则

RESTful风格的核心是用HTTP动词表达操作,资源用URL表示。例如:

  • GET /users → 获取用户列表
  • POST /users → 创建新用户
  • GET /users/1 → 获取ID为1的用户
  • PUT /users/1 → 更新ID为1的用户
  • DELETE /users/1 → 删除ID为1的用户

4. 创建实体类(User)

src/main/java/com/example/demoapi/entity 目录下创建 User 类:

千问智学
千问智学

阿里旗下AI教育应用(原夸克学习APP)

下载
package com.example.demoapi.entity;
<p>public class User {
private Long id;
private String name;
private String email;</p><pre class='brush:java;toolbar:false;'>// 构造函数
public User() {}

public User(Long id, String name, String email) {
    this.id = id;
    this.name = name;
    this.email = email;
}

// Getter 和 Setter 方法
public Long getId() { return id; }
public void setId(Long id) { this.id = id; }

public String getName() { return name; }
public void setName(String name) { this.name = name; }

public String getEmail() { return email; }
public void setEmail(String email) { this.email = email; }

}

5. 创建Controller处理HTTP请求

src/main/java/com/example/demoapi/controller 下创建 UserController:

package com.example.demoapi.controller;
<p>import com.example.demoapi.entity.User;
import org.springframework.web.bind.annotation.*;</p><p>import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicLong;</p><p>@RestController
@RequestMapping("/users")
public class UserController {</p><pre class='brush:java;toolbar:false;'>private List<User> users = new ArrayList<>();
private AtomicLong counter = new AtomicLong();

// 初始化一些测试数据
public UserController() {
    users.add(new User(counter.incrementAndGet(), "张三", "zhangsan@example.com"));
    users.add(new User(counter.incrementAndGet(), "李四", "lisi@example.com"));
}

// GET /users - 获取所有用户
@GetMapping
public List<User> getAllUsers() {
    return users;
}

// GET /users/{id} - 获取指定用户
@GetMapping("/{id}")
public User getUserById(@PathVariable Long id) {
    return users.stream()
            .filter(user -> user.getId().equals(id))
            .findFirst()
            .orElse(null);
}

// POST /users - 创建新用户
@PostMapping
public User createUser(@RequestBody User user) {
    user.setId(counter.incrementAndGet());
    users.add(user);
    return user;
}

// PUT /users/{id} - 更新用户
@PutMapping("/{id}")
public User updateUser(@PathVariable Long id, @RequestBody User updatedUser) {
    for (User user : users) {
        if (user.getId().equals(id)) {
            user.setName(updatedUser.getName());
            user.setEmail(updatedUser.getEmail());
            return user;
        }
    }
    return null;
}

// DELETE /users/{id} - 删除用户
@DeleteMapping("/{id}")
public String deleteUser(@PathVariable Long id) {
    boolean removed = users.removeIf(user -> user.getId().equals(id));
    return removed ? "删除成功" : "用户不存在";
}

}

6. 启动并测试API

运行主类(通常叫 DemoApiApplication),启动成功后访问:

  • GET http://localhost:8080/users → 查看所有用户
  • GET http://localhost:8080/users/1 → 查看ID为1的用户
  • POST http://localhost:8080/users → Body 中提交 JSON 数据创建用户
  • PUT http://localhost:8080/users/1 → 更新用户信息
  • DELETE http://localhost:8080/users/1 → 删除用户

你可以用Postman或curl测试,例如创建用户的POST请求Body:

{
    "name": "王五",
    "email": "wangwu@example.com"
}

7. 小结与扩展建议

你现在已成功搭建了一个基本的RESTful API服务。虽然当前数据存在内存中,但结构清晰,适合学习理解REST原理。

下一步可以考虑:

  • 集成数据库(如 MySQL + JPA/Hibernate)
  • 添加数据校验(@Valid)
  • 统一返回格式(如封装 Result 对象)
  • 加入异常处理(@ControllerAdvice)
  • 使用Swagger生成API文档

基本上就这些,不复杂但容易忽略细节。照着做一遍,你就掌握了Java构建RESTful接口的基本能力。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
mysql修改数据表名
mysql修改数据表名

MySQL修改数据表:1、首先查看数据库中所有的表,代码为:‘SHOW TABLES;’;2、修改表名,代码为:‘ALTER TABLE 旧表名 RENAME [TO] 新表名;’。php中文网还提供MySQL的相关下载、相关课程等内容,供大家免费下载使用。

682

2023.06.20

MySQL创建存储过程
MySQL创建存储过程

存储程序可以分为存储过程和函数,MySQL中创建存储过程和函数使用的语句分别为CREATE PROCEDURE和CREATE FUNCTION。使用CALL语句调用存储过程智能用输出变量返回值。函数可以从语句外调用(通过引用函数名),也能返回标量值。存储过程也可以调用其他存储过程。php中文网还提供MySQL创建存储过程的相关下载、相关课程等内容,供大家免费下载使用。

452

2023.06.21

mongodb和mysql的区别
mongodb和mysql的区别

mongodb和mysql的区别:1、数据模型;2、查询语言;3、扩展性和性能;4、可靠性。本专题为大家提供mongodb和mysql的区别的相关的文章、下载、课程内容,供大家免费下载体验。

286

2023.07.18

mysql密码忘了怎么查看
mysql密码忘了怎么查看

MySQL是一个关系型数据库管理系统,由瑞典MySQL AB 公司开发,属于 Oracle 旗下产品。MySQL 是最流行的关系型数据库管理系统之一,在 WEB 应用方面,MySQL是最好的 RDBMS 应用软件之一。那么mysql密码忘了怎么办呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

519

2023.07.19

mysql创建数据库
mysql创建数据库

MySQL是一个关系型数据库管理系统,由瑞典MySQL AB 公司开发,属于 Oracle 旗下产品。MySQL 是最流行的关系型数据库管理系统之一,在 WEB 应用方面,MySQL是最好的 RDBMS 应用软件之一。那么mysql怎么创建数据库呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

265

2023.07.25

mysql默认事务隔离级别
mysql默认事务隔离级别

MySQL是一种广泛使用的关系型数据库管理系统,它支持事务处理。事务是一组数据库操作,它们作为一个逻辑单元被一起执行。为了保证事务的一致性和隔离性,MySQL提供了不同的事务隔离级别。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

392

2023.08.08

sqlserver和mysql区别
sqlserver和mysql区别

SQL Server和MySQL是两种广泛使用的关系型数据库管理系统。它们具有相似的功能和用途,但在某些方面存在一些显著的区别。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

541

2023.08.11

mysql忘记密码
mysql忘记密码

MySQL是一种关系型数据库管理系统,关系数据库将数据保存在不同的表中,而不是将所有数据放在一个大仓库内,这样就增加了速度并提高了灵活性。那么忘记mysql密码我们该怎么解决呢?php中文网给大家带来了相关的教程以及其他关于mysql的文章,欢迎大家前来学习阅读。

665

2023.08.14

Swift iOS架构设计与MVVM模式实战
Swift iOS架构设计与MVVM模式实战

本专题聚焦 Swift 在 iOS 应用架构设计中的实践,系统讲解 MVVM 模式的核心思想、数据绑定机制、模块拆分策略以及组件化开发方法。内容涵盖网络层封装、状态管理、依赖注入与性能优化技巧。通过完整项目案例,帮助开发者构建结构清晰、可维护性强的 iOS 应用架构体系。

3

2026.03.03

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 2.4万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 842人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号