Java Spring Boot 写 API 接口

在当今快速的软件开发世界中，构建 API 接口是非常常见的任务。因为许多应用程序需要通过 API 接口来与其他应用程序通信。API 接口不仅可以提供应用程序的数据，还可以将应用程序的功能公开为可重用的服务。Java Spring Boot 是一个用于创建独立、产品级别的 Spring 应用程序的框架。它简化了 Spring 应用程序的搭建和部署，并提供了开箱即用的配置和常用功能，如自动配置、内嵌服务器等。在本文中，我们将学习如何使用 Java Spring Boot 来构建 API 接口。

第一步：创建新的 Spring Boot 项目

首先，我们需要创建一个新的 Spring Boot 项目。您可以使用 Eclipse、IntelliJ IDEA 或其他支持 Spring Boot 的 IDE 来创建项目，也可以使用 Spring Initializr（https://start.spring.io/）生成一个新的项目。在创建项目时，请选择所需的依赖项，如 Spring Web 和 Spring Data JPA，以便在项目中使用 Web 和数据库功能。

第二步：创建 Controller 类

在创建了项目之后，我们需要创建一个 Controller 类来处理 API 请求和响应。Controller 是一个 Spring 组件，用于处理来自客户端的请求，并返回响应。在 Controller 类上添加 @RestController 注解，以告诉 Spring 该类是一个控制器。@RequestMapping 注解用于指定 API 的 URL 路径。例如，在下面的示例中，我们将创建一个名为 ApiController 的 Controller。

注解介绍：

@RestController：这是一个组合注解，它等于添加了@Controller和@ResponseBody注解。

@RequestMapping：用于将 HTTP 请求映射到 Controller 类的特定方法。可以指定 URL 路径、HTTP 方法和其他参数。

@GetMapping：表示 HTTP GET 请求方法。

@PostMapping：表示 HTTP POST 请求方法。

@RequestBody：用于将 HTTP 请求的 body 内容转换为 Java 对象。

示例代码：

import org.springframework.web.bind.annotation.*;@RestController
@RequestMapping("/api")
public class ApiController {@GetMapping("/hello")public String sayHello() {return "Hello, Spring Boot!";}@PostMapping("/users")public User createUser(@RequestBody User user) {// 保存用户到数据库// ...return user;}
}

在上面的示例中，我们定义了两个 API 接口：

  • GET /api/hello：当客户端发送 GET 请求时，Controller 将返回字符串 “Hello, Spring Boot!”。
  • POST /api/users：当客户端发送 POST 请求时，Controller 将接收一个 User 对象，并将其保存到数据库中。最后，Controller 将返回保存的 User 对象。

第三步：创建实体类

如果 API 需要处理和返回数据对象，可以创建一个实体类来表示数据模型。实体类通常与数据库表相对应，并且可以使用 ORM 工具（如 Hibernate）来映射到数据库。在实体类上使用 @Entity 注解，以表示该类是一个数据库实体。使用 @Id 和 @GeneratedValue 注解来定义实体的主键。

示例代码：

import javax.persistence.*;@Entity
@Table(name = "users")
public class User {@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;private String name;// 省略getter和setter方法
}

在上面的示例中，我们定义了一个名为 User 的实体类。它有一个 id 属性和一个 name 属性。id 属性用于标识 User 对象的唯一性，并使用 @GeneratedValue 注解指定自动生成主键。name 属性是一个字符串类型的属性，用于存储 User 的名称。

第四步：运行应用程序

现在，我们已经创建了一个简单的 Spring Boot 应用程序，其中包含一个 API 接口和一个实体类。我们可以启动应用程序，并访问 API 的 URL 路径来测试 API 接口。

启动应用程序：

$ mvn spring-boot:run

测试 API 接口：

$ curl http://localhost:8080/api/hello
Hello, Spring Boot!$ curl -X POST -H "Content-Type: application/json" \-d '{"name": "Alice"}' http://localhost:8080/api/users
{"id": 1, "name": "Alice"}

在上面的示例中，我们使用 cURL 工具来测试 API 接口。通过 GET 请求 /api/hello 接口，我们得到了 “Hello, Spring Boot!” 的响应。通过 POST 请求 /api/users 接口，我们创建了一个名为 Alice 的 User 对象，并得到了新创建的 User 对象的响应。

案例

案例一：用户管理系统

假设我们要构建一个用户管理系统，可以实现用户的创建、查询、更新和删除操作。我们可以使用 Java Spring Boot 来构建这个系统的 API 接口。

  1. 创建 User 实体类：
@Entity
@Table(name = "users")
public class User {@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;private String username;private String email;// 省略getter和setter方法
}
  1. 创建 UserController：
@RestController
@RequestMapping("/api/users")
public class UserController {@Autowiredprivate UserRepository userRepository;@GetMappingpublic List<User> getUsers() {return userRepository.findAll();}@GetMapping("/{id}")public User getUserById(@PathVariable Long id) {return userRepository.findById(id).orElseThrow(() -> new NotFoundException("User not found"));}@PostMappingpublic User createUser(@RequestBody User user) {return userRepository.save(user);}@PutMapping("/{id}")public User updateUser(@PathVariable Long id, @RequestBody User updatedUser) {User user = userRepository.findById(id).orElseThrow(() -> new NotFoundException("User not found"));user.setUsername(updatedUser.getUsername());user.setEmail(updatedUser.getEmail());return userRepository.save(user);}@DeleteMapping("/{id}")public void deleteUser(@PathVariable Long id) {userRepository.deleteById(id);}
}
  1. 创建 UserRepository：
@Repository
public interface UserRepository extends JpaRepository<User, Long> {
}

案例二：订单管理系统

假设我们要构建一个订单管理系统，可以实现订单的创建、查询、更新和删除操作。我们可以使用 Java Spring Boot 来构建这个系统的 API 接口。

  1. 创建 Order 实体类：
@Entity
@Table(name = "orders")
public class Order {@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;private String orderNumber;private String customerName;// 省略getter和setter方法
}
  1. 创建 OrderController：
@RestController
@RequestMapping("/api/orders")
public class OrderController {@Autowiredprivate OrderRepository orderRepository;@GetMappingpublic List<Order> getOrders() {return orderRepository.findAll();}@GetMapping("/{id}")public Order getOrderById(@PathVariable Long id) {return orderRepository.findById(id).orElseThrow(() -> new NotFoundException("Order not found"));}@PostMappingpublic Order createOrder(@RequestBody Order order) {return orderRepository.save(order);}@PutMapping("/{id}")public Order updateOrder(@PathVariable Long id, @RequestBody Order updatedOrder) {Order order = orderRepository.findById(id).orElseThrow(() -> new NotFoundException("Order not found"));order.setOrderNumber(updatedOrder.getOrderNumber());order.setCustomerName(updatedOrder.getCustomerName());return orderRepository.save(order);}@DeleteMapping("/{id}")public void deleteOrder(@PathVariable Long id) {orderRepository.deleteById(id);}
}
  1. 创建 OrderRepository：
@Repository
public interface OrderRepository extends JpaRepository<Order, Long> {
}

案例三：商品管理系统

假设我们要构建一个商品管理系统，可以实现商品的创建、查询、更新和删除操作。我们可以使用 Java Spring Boot 来构建这个系统的 API 接口。

  1. 创建 Product 实体类：
@Entity
@Table(name = "products")
public class Product {@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;private String name;private String description;private BigDecimal price;// 省略getter和setter方法
}
  1. 创建 ProductController：
@RestController
@RequestMapping("/api/products")
public class ProductController {@Autowiredprivate ProductRepository productRepository;@GetMappingpublic List<Product> getProducts() {return productRepository.findAll();}@GetMapping("/{id}")public Product getProductById(@PathVariable Long id) {return productRepository.findById(id).orElseThrow(() -> new NotFoundException("Product not found"));}@PostMappingpublic Product createProduct(@RequestBody Product product) {return productRepository.save(product);}@PutMapping("/{id}")public Product updateProduct(@PathVariable Long id, @RequestBody Product updatedProduct) {Product product = productRepository.findById(id).orElseThrow(() -> new NotFoundException("Product not found"));product.setName(updatedProduct.getName());product.setDescription(updatedProduct.getDescription());product.setPrice(updatedProduct.getPrice());return productRepository.save(product);}@DeleteMapping("/{id}")public void deleteProduct(@PathVariable Long id) {productRepository.deleteById(id);}
}
  1. 创建 ProductRepository：
@Repository
public interface ProductRepository extends JpaRepository<Product, Long> {
}

通过以上示例，我们可以看到使用 Java Spring Boot 构建 API 接口非常简单和高效。我们可以根据具体的业务需求创建相应的实体类、Controller 类和 Repository 接口来处理数据操作，并通过启动应用程序进行测试和验证。

总结

本文介绍了如何使用 Java Spring Boot 构建 API 接口。我们创建了一个新的 Spring Boot 项目，并添加了一个 Controller 类来处理 API 请求和响应。我们还创建了一个实体类来表示数据模型。最后，我们启动了应用程序，并测试了 API 接口。如果您想要进一步学习 Spring Boot，可以查看 Spring 官方文档（https://spring.io/projects/spring-boot）和教程。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/95621.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Android Studio实现简易计算器（带横竖屏，深色浅色模式，更该按钮颜色，selector，style的使用）

Android Studio实现简易计算器（带横竖屏，深色浅色模式，更该按钮颜色，selector，style的使用）

目录 前言 运行结果&#xff1a; 运行截屏&#xff08;p50e&#xff09; apk文件 源码文件 项目结构 总览 MainActivity.java drawable 更改图标的方法&#xff1a; blackbutton.xml bluebuttons.xml greybutton.xml orangebuttons.xml whitebutton.xml layout 布…
阅读更多...
关联规则挖掘（上）：数据分析 | 数据挖掘 | 十大算法之一

关联规则挖掘（上）：数据分析 | 数据挖掘 | 十大算法之一

⭐️⭐️⭐️⭐️⭐️欢迎来到我的博客⭐️⭐️⭐️⭐️⭐️ &#x1f434;作者&#xff1a;秋无之地 &#x1f434;简介&#xff1a;CSDN爬虫、后端、大数据领域创作者。目前从事python爬虫、后端和大数据等相关工作&#xff0c;主要擅长领域有&#xff1a;爬虫、后端、大数据…
阅读更多...
复习 --- QT服务器客户端

复习 --- QT服务器客户端

服务器&#xff1a; 头文件&#xff1a; #ifndef WIDGET_H #define WIDGET_H#include <QWidget> #include<QTcpServer> #include<QTcpSocket> #include<QMessageBox> #include<QDebug> #include<QList> #include<QListWidget> #in…
阅读更多...
[C国演义] 第十三章

[C国演义] 第十三章

第十三章 三数之和四数之和 三数之和 力扣链接 根据题目要求: 返回的数对应的下标各不相同三个数之和等于0不可包含重复的三元组 – – 即顺序是不做要求的 如: [-1 0 1] 和 [0, 1, -1] 是同一个三元组输出答案顺序不做要求 暴力解法: 排序 3个for循环 去重 — — N^3, …
阅读更多...
IDT 一款自动化挖掘未授权访问漏洞的信息收集工具

IDT 一款自动化挖掘未授权访问漏洞的信息收集工具

IDT v1.0 IDT 意为 Interface detection&#xff08;接口探测) 项目地址: https://github.com/cikeroot/IDT/该工具主要的功能是对批量url或者接口进行存活探测&#xff0c;支持浏览器自动打开指定的url&#xff0c;避免手动重复打开网址。只需输入存在批量的url文件即可。 …
阅读更多...
stm32之HAL库操作PAJ75620

stm32之HAL库操作PAJ75620

一、模块简介 手势模块PAJ7620主要利用IIC或SPI协议来实现数据的传输&#xff0c;本实验用的模块是以IIC来进行信息传输。支持电压从2.8v到3.6v, 正常可以选择3.3v。检测的距离从5到15cm, 可以检测9种手势&#xff0c;包括 右&#xff1a;编码为 0x01左&#xff1a;编码为 0x0…
阅读更多...
前端TypeScript学习day01-TS介绍与TS常用类型

前端TypeScript学习day01-TS介绍与TS常用类型

(创作不易&#xff0c;感谢有你&#xff0c;你的支持&#xff0c;就是我前行的最大动力&#xff0c;如果看完对你有帮助&#xff0c;请留下您的足迹&#xff09; 目录 TypeScript 介绍 TypeScript 是什么 TypeScript 为什么要为 JS 添加类型支持&#xff1f; TypeScript 相…
阅读更多...
vertx的学习总结7之用kotlin 与vertx搞一个简单的http

vertx的学习总结7之用kotlin 与vertx搞一个简单的http

这里我就简单的聊几句&#xff0c;如何用vertx web来搞一个web项目的 1、首先先引入几个依赖&#xff0c;这里我就用maven了&#xff0c;这个是kotlinvertx web <?xml version"1.0" encoding"UTF-8"?> <project xmlns"http://maven.apac…
阅读更多...
win10、win11安装Ubuntu 22.04

win10、win11安装Ubuntu 22.04

目前为止&#xff08;2023年10月6日&#xff09;&#xff0c;最新的 Ubuntu 版本是 Ubuntu 22.04。你可以按照以下步骤在 Windows 上使用 WSL 安装 Ubuntu 22.04&#xff1a; 检查系统要求&#xff1a; 确保你的操作系统是 Windows 10 或更高版本&#xff0c;并已安装 Windows …
阅读更多...
调试器通用波形显示工具

调试器通用波形显示工具

前言&#xff1a;事情起因是我们实验室买了个无线调试器是CMSIS-DAP的&#xff0c;无法使用J-SCOPE显示波形来方便调PID&#xff0c;所以我就在网上找到了个开源工具链接&#xff1a;http://t.csdnimg.cn/ZqZPY使用方法&#xff1a;工具是好工具&#xff0c;就是没有使用手册&a…
阅读更多...
操作系统知识

操作系统知识

操作系统基础 什么是操作系统&#xff1f; 通过以下四点可以概括操作系统到底是什么&#xff1a; 操作系统&#xff08;Operating System&#xff0c;简称 OS&#xff09;是管理计算机硬件与软件资源的程序&#xff0c;是计算机的基石。操作系统本质上是一个运行在计算机上的…
阅读更多...
golang gin框架1——简单案例以及api版本控制

golang gin框架1——简单案例以及api版本控制

gin框架 gin是golang的一个后台WEB框架 简单案例 package mainimport ("github.com/gin-gonic/gin""net/http" )func main() {r : gin.Default()r.GET("/ping", func(c *gin.Context) {//以json形式输出&#xff0c;还可以xml protobufc.JSON…
阅读更多...
二、互联网技术——网络协议

二、互联网技术——网络协议

文章目录 一、OSI与TCP/IP参考模型二、TCP/IP参考模型各层功能三、TCP/IP参考模型与对应协议四、常用协议与功能五、常用协议端口 一、OSI与TCP/IP参考模型 二、TCP/IP参考模型各层功能 三、TCP/IP参考模型与对应协议 例题&#xff1a;TCP/IP模型包含四个层次&#xff0c;由上至…
阅读更多...
您的报告生成器可以动态执行此操作吗？ViewPro可以

您的报告生成器可以动态执行此操作吗？ViewPro可以

ViewPro for .NET 和 ActiveX&#xff1a;报告生成器、打印引擎和打印预览 ViewPro 允许您将打印预览和报告生成器集成到您的 .NET 和 VB6 项目以及其他项目中。您可以使用 ViewPro 构建基于图形和文本的报告或技术绘图&#xff0c;在表单上的滚动和缩放查看器中显示结果&…
阅读更多...
Ubuntu无法引导启动的修复

Ubuntu无法引导启动的修复

TLDR&#xff1a;使用Boot-Repair工具。 Boot-Repair Boot-Repair是一个简单的工具&#xff0c;用于修复您在Ubuntu中可能遇到的常见启动问题&#xff0c;例如在安装Windows或其他Linux发行版后无法启动Ubuntu时&#xff0c;或者在安装Ubuntu后无法启动Windows时&#xff0c;…
阅读更多...
【C语言】善于利用指针（一）

【C语言】善于利用指针（一）

&#x1f497;个人主页&#x1f497; ⭐个人专栏——C语言初步学习⭐ &#x1f4ab;点击关注&#x1f929;一起学习C语言&#x1f4af;&#x1f4ab; 目录 导读&#xff1a; 1. 什么是指针 1.1 概念 1.2 图解 1.3 示例 2. 指针和指针类型 2.1 指针的定义 2.2 指针的解引…
阅读更多...
【图像处理GIU】图像分割（Matlab代码实现）

【图像处理GIU】图像分割（Matlab代码实现）

&#x1f4a5;&#x1f4a5;&#x1f49e;&#x1f49e;欢迎来到本博客❤️❤️&#x1f4a5;&#x1f4a5; &#x1f3c6;博主优势&#xff1a;&#x1f31e;&#x1f31e;&#x1f31e;博客内容尽量做到思维缜密&#xff0c;逻辑清晰&#xff0c;为了方便读者。 ⛳️座右铭&a…
阅读更多...
c++【3】 常量、指针、指针变量、变量指针

c++【3】 常量、指针、指针变量、变量指针

常量是固定值&#xff0c;在程序执行期间不会改变。这些固定的值&#xff0c;又叫做字面量。 常量可以是任何的基本数据类型&#xff0c;可分为整型数字、浮点数字、字符、字符串和布尔值。 常量就像是常规的变量&#xff0c;只不过常量的值在定义后不能进行修改。 1.指针应用…
阅读更多...
想要精通算法和SQL的成长之路 - 并查集的运用和案例（省份数量）

想要精通算法和SQL的成长之路 - 并查集的运用和案例（省份数量）

想要精通算法和SQL的成长之路 - 并查集的运用 前言一. 并查集的使用和模板1.1 初始化1.2 find 查找函数1.3 union 合并集合1.4 connected 判断相连性1.5 完整代码 二. 运用案例 - 省份数量 前言 想要精通算法和SQL的成长之路 - 系列导航 一. 并查集的使用和模板 先说一下并查集…
阅读更多...
源码分享-M3U8数据流ts的AES-128解密并合并---GoLang实现

源码分享-M3U8数据流ts的AES-128解密并合并---GoLang实现

之前使用C语言实现了一次&#xff0c;见M3U8数据流ts的AES-128解密并合并。 学习了Go语言后&#xff0c;又用Go重新实现了一遍。源码如下&#xff0c;无第三方库依赖。 package mainimport ("crypto/aes""crypto/cipher""encoding/binary"&quo…
阅读更多...
最新文章

Copyright @ 2022~2023