Skip to content
On this page

创建 API

创建第一个 API

  1. 为了保证工程结构清晰,我们将不同用处的类归并到对应功能描述的package中。

  2. 创建API用到的是Controller,所以我们新建一个controllerpackage并新建一个DemoController的类。

  3. 新建一个最简单的API

  4. @RestController 注解相当于@ResponseBody@Controller合在一起的作用。

  5. @RequestMapping("api")将当前DemoController下的方法增加一个前缀api,可以快速定位。

  6. 以下代码定义了一个info方法,传入 name 参数,返回"Hello, Response success: " + info的字符串。

java
/**
	 * 测试接口
	 * @param info 输入信息
	 * @return {@link String}
	 */
	@RequestMapping("/info")
	public String info(String info) {
		return "Hello,Response success:" + info;
	}
  1. 重启DemoApplication或者使用快捷键Ctrl+F9重载 class,让我们新建的API生效

  2. 我们以9010的端口启动了cbb-demo,那么要访问这个API的话,则地址为: http://localhost:9010/api/info?info=demo-success

  3. 我们使用 Apifox 或者其他 api 调试工具调用接口查看结果

  4. 请求成功,但是返回的消息是:未能读取到有效Token,这是为何?

  5. 因为任何一个 API,都需要考虑安全性,不能让未授权的请求,调用到受保护的 API,那么就需要一个安全框架来支撑。

API 安全框架

  • Spring 生态中有一个 sa-token 第三方组件,功能非常完善,那么下面我们来学习下 API 的鉴权吧!