介绍

本文将介绍如何在 Java 程序中使用 Spring Rest API。Spring Rest API 是一种用于构建 RESTful Web 服务的开源框架，提供了一些方便的功能，如路由、参数解析、异常处理等。

步骤

步骤一：创建 Maven 项目

首先，我们需要创建一个空的 Maven 项目。在控制台输入以下命令：

mvn archetype:generate -DgroupId=com.example -DartifactId=spring-rest-api -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

这将创建一个空的 Maven 项目，项目名称为 "spring-rest-api"。我们可以在 pom.xml 文件中添加 Spring Rest API 的依赖，如下所示：

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

此处我们使用的是 Spring Boot 2.5.5 版本，也可以根据需要选择其他版本。

步骤二：创建 RESTful 接口

接下来，我们需要创建一个 RESTful 接口。在 src/main/java/com/example 目录下创建一个名为 "HomeController.java" 的文件，内容如下：

@RestController
public class HomeController {
    @GetMapping("/")
    public String index() {
        return "Hello, Spring Rest API!";
    }
}

这里我们定义了一个名为 "HomeController" 的类，使用了 @RestController 注解，表明这是一个 RESTful 控制器。在 index() 方法中，我们使用了 @GetMapping 注解，表示这是一个 GET 请求处理函数，"/" 表示根路径。该函数通过返回一个字符串来响应请求。

步骤三：启动应用程序

我们可以使用 Spring Boot 的内置服务器来启动应用程序。在控制台输入以下命令：

mvn spring-boot:run

此时，控制台会输出一些记录，其中包含了应用程序启动后的访问地址，如下所示：

2021-09-23 15:23:31.119  INFO 61419 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2021-09-23 15:23:31.125  INFO 61419 --- [           main] com.example.SpringRestApiApplication    : Started SpringRestApiApplication in 1.79 seconds (JVM running for 2.164)

我们可以在浏览器中输入该地址，即可看到 "Helle, Spring Rest API!" 的字符串。

步骤四：创建其他接口

除了 "/" 接口之外，我们还可以创建其他接口。在 HomeController 中定义其他方法，用不同的路径和请求方法来区分接口。例如：

@RestController
public class HomeController {
    @GetMapping("/")
    public String index() {
        return "Hello, Spring Rest API!";
    }

    @GetMapping("/api")
    public String api() {
        return "This is an API endpoint";
    }

    @PostMapping("/submit")
    public void submit(@RequestBody String data) {
        System.out.println(data);
    }
}

其中，"/api" 接口是一个 GET 请求，响应 "This is an API endpoint" 的字符串；"/submit" 接口是一个 POST 请求，打印请求体中的字符串。

步骤五：自定义配置

除了使用默认的配置以外，我们还可以自定义一些配置。在 src/main/resources 目录下创建 "application.properties" 文件，可以配置访问的端口号，例如：

server.port = 8081

这里将默认的端口号改为了 8081。我们可以重新运行应用程序来应用这些配置。

总结

本文介绍了如何使用 Spring Rest API 来构建 RESTful Web 服务，包括创建 Maven 项目、创建 RESTful 接口、启动应用程序、自定义配置等步骤。Spring Rest API 提供了方便的路由、参数解析、异常处理等功能，可以大大简化开发过程，提高开发效率。