如何实现一个最基本的API接口

迈不过友情╰ 2024-02-17 13:31 80阅读 0赞

#### 如何实现一个最基本的API接口 ####

*  1. 选择构建工具
 *  2. 在pom文件中添加必要的内容
 *  3. 启动类
 *  4. Controller
 *  5. 调用结果
 *  6. 易错点

## 1. 选择构建工具 ##

本文中的例子选择Maven，具体选择取决于个人或团队的偏好、项目需求以及经验水平。

## 2. 在pom文件中添加必要的内容 ##

![在这里插入图片描述][42f7f821e7bd412ab140b79f099d52af.png]  
1）**指定Spring Boot应用程序的父项目**，本段代码的作用是将当前项目设置为Spring Boot应用程序，并继承Spring Boot的父项目，以便共享配置和依赖管理。

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.8.RELEASE</version>
        <relativePath/>
    </parent>

2）**添加一个Spring Boot的Web Starter依赖项**。利用Spring Boot提供的预配置来轻松地开始开发基于Web的应用程序，而无需手动配置大量的依赖项。这个依赖项包含了一组通常用于构建Web应用程序的库和工具。

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

## 3. 启动类 ##

![在这里插入图片描述][bf12213f65814be98a9bcaba12d331fc.png]

**@SpringBootApplication 注解**通常用于标识应用程序的主类。它是一个组合注解，包括了以下**三个注解的功能**：

1.  @Configuration: 表示该类是一个配置类，它可以包含配置 Bean 的方法。
2.  @EnableAutoConfiguration: 启用自动配置，Spring Boot 将根据项目的依赖自动配置应用程序。
3.  @ComponentScan: 启用组件扫描，Spring Boot 将扫描指定包及其子包中的组件，包括被 @Component、@Service、@Repository 和 @Controller 注解标记的类。

使用 @SpringBootApplication 注解的类通常是 Spring Boot 应用程序的入口点，其中包含了 main 方法，通过该方法启动 Spring Boot 应用。

在例子中，@SpringBootApplication 注解标记了 Main 类。main 方法使用 SpringApplication.run() 启动了 Spring Boot 应用程序。Spring Boot 将**自动进行配置和组件扫描**，使得应用程序能够运行起来。

SpringApplication.run(Main.class, args);执行后，Spring Boot 将会自动完成以下操作：  
1）初始化 Spring 应用上下文（ApplicationContext）。  
2）执行自动配置（Auto-Configuration）。  
3）扫描类路径上的组件并注册它们。  
4）启动嵌入式的 Web 服务器（如果应用程序是一个 Web 应用）。  
5）执行任何其他初始化操作，确保应用程序能够运行。

**总结来说**，这一行代码的目的是启动 Spring Boot 应用程序，并通过注解驱动的方式完成应用程序的配置和初始化。这种简洁的启动方式是 Spring Boot 的一个关键特性，使得开发者能够更专注于业务逻辑而不必过多关注框架的配置。

## 4. Controller ##

![在这里插入图片描述][e25936e702c646fa80c472db325a4c03.png]  
在Spring框架中，@Controller 注解用于标识一个类是Spring MVC中的控制器（Controller）。控制器类负责处理用户请求，调用业务逻辑，然后返回一个视图给用户。Spring MVC是基于模型-视图-控制器（MVC）设计模式的Web框架，其中控制器负责处理用户的请求和管理流程。

@RestController 是 Spring Framework 中的一个注解，它是 @Controller 注解和 @ResponseBody 注解的组合。它用于标识一个类是一个控制器，同时其中的方法会直接返回数据而不是视图。

在传统的 Spring MVC 应用中，@Controller 用于处理 HTTP 请求，并通过视图解析器解析返回的字符串（通常是视图名称），最终呈现给用户的是一个HTML页面。而在 RESTful 风格的服务中，我们更倾向于直接返回数据，而不是 HTML 页面。

@RestController 更适合用于构建 RESTful 风格的服务。当使用 @RestController 注解标记一个类时，它的每个方法默认都会以 JSON 格式返回数据，而不是将返回值解析为视图名称。这样就省去了在每个方法上使用 @ResponseBody 的需要。

**@RequestMapping(“/api”) 注解定义了基本的请求映射路径:**

1.  @RequestMapping 是 Spring MVC 中用于映射 HTTP 请求路径的注解。它可以用在类级别和方法级别，用于指定处理请求的路径。
2.  在类级别上，@RequestMapping 注解用于指定整个类的基本路径，而在方法级别上，它用于进一步追加路径或定义具体的处理路径。

**@GetMapping(“/hello”) 注解表示处理 GET 请求，并定义了相对于 /api 的路径:**

1.  @GetMapping 是 Spring MVC 中的一个注解，它是 @RequestMapping 注解的缩写形式，专门用于处理 HTTP GET 请求。通过使用 @GetMapping 注解，可以更简洁地指定处理 GET 请求的路径，而不必显式指定 method = RequestMethod.GET。

## 5. 调用结果 ##

![在这里插入图片描述][341c53d2a11c4a518e8867a01ba0bff2.png]

## 6. 易错点 ##

我们的主启动类必须置于业务代码的最外层,否则我们写的一些类不能被扫描注册到bean，进而出现下面的界面：

![在这里插入图片描述][86cfe38184ee42ed82488ec3b4fcd9d6.png]  
正确的结构：

![在这里插入图片描述][e64669ada0454729b83a63a04901c9e0.png]

[42f7f821e7bd412ab140b79f099d52af.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/e291731a61324a888bc259e458af4a7b.png
[bf12213f65814be98a9bcaba12d331fc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/84efa74be8864852856eec7a3f93c2bc.png
[e25936e702c646fa80c472db325a4c03.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/5b9cbe8e35e54653b71fc9108f4b4285.png
[341c53d2a11c4a518e8867a01ba0bff2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/001d909cea4c4451ad19e1ecb7a5480b.png
[86cfe38184ee42ed82488ec3b4fcd9d6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/1c2df1db675a41b39d758a3730e88ca7.png
[e64669ada0454729b83a63a04901c9e0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/6762d8328d1248558f7d28989bd944a6.png