如何编写数据接口

背景

        在Java开发中，数据接口通常指的是用于定义数据传输的规范或协议的接口。数据接口定义了数据的格式、结构和交互方式，使得不同系统、模块或组件能够以统一的方式进行数据交换和通信。

规范数据传输格式	数据接口定义了数据的结构和格式，确保数据在不同系统之间能够正确传输和解析，避免因数据格式不一致而导致的通信错误。
实现系统间通信	通过数据接口，不同系统或模块之间能够进行数据交换和通信。例如，前端页面通过调用后端接口获取数据，不同服务之间通过接口进行数据传递等。
降低耦合度	通过接口隔离数据传输的具体实现细节，不同模块只需遵循接口定义即可实现数据交互，降低了模块之间的耦合度，提高了系统的灵活性和可维护性。
提高扩展性	通过定义接口，可以方便地对系统进行扩展或修改，只需保持接口不变，而实现类可以根据需求进行调整。

实操

        第一种 

                        基于ApiPost工具访问接口返回一段话

package com.example.demo;

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author 阿龙
 * @date 2024/4/2 1:20
 */
@RestController
public class Test01Controller {
    @PostMapping("/yes01")
    public String getData() {
        // 这里可以编写获取数据的逻辑，可以是从数据库、文件、API等获取数据
        String data = "Hello, world!";
        return data;
    }
}

        第二种

                        基于ApiPost工具访问接口携带JSON格式参数，后台进行判断并返回自定义JSON结果(成功 200|失败 404)；

package com.example.demo;

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author 阿龙
 * @date 2024/4/2 1:20
 */
@RestController
public class Test02Controller {
    @PostMapping("/yes02")
    public CustomResponse getData(@RequestBody RequestData requestData) {
        // 获取请求中的姓名和部门字段
        String name = requestData.getName();
        String department = requestData.getDepartment();

        // 进行数据处理或其他逻辑
        // 这里只是简单示例，实际应用中可以根据自己的业务逻辑来处理数据

        // 构建自定义的JSON格式数据
        CustomResponse customResponse = new CustomResponse();
        // 假设这里是根据业务逻辑进行判断的地方
        if ("John Doe".equals(name)) {
            customResponse.setMessage("Hello, " + name + " from " + department + "!");
            customResponse.setStatus(200); // 设置状态为成功，即200
        } else {
            customResponse.setMessage("Hello, " + name + " 查无此人 !");
            customResponse.setStatus(404); // 设置状态为失败，即404
        }

        return customResponse;
    }
}

    //参数
    class RequestData {
    private String name;
    private String department;

        public String getName() {
            return name;
        }

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

        public String getDepartment() {
            return department;
        }

        public void setDepartment(String department) {
            this.department = department;
        }
    }

    //返回值
    class CustomResponse {
    private String message;
    private int status;

        public int getStatus() {
            return status;
        }

        public void setStatus(int status) {
            this.status = status;
        }

        public String getMessage() {
            return message;
        }

        public void setMessage(String message) {
            this.message = message;
        }
    }