OneApi 基于 Spring Boot 框架运行,通过依赖的方式引入到 Java Web 项目中。和其他方式开发的接口一样通过 HTTP 方式调取,OneApi 只是一种新的接口内容的开发方式,并不改变 Spring Boot 的任何东西。
示例项目源码地址:
https://github.com/qross-io/OneApi
示例项目的环境要求如下:
作者建议使用Intellij Idea
作为 PQL 的开发环境,需要Intellij Idea 2018
或以上版本。
示例项目中已经预先添加了一些文件和配置:
ApiController
包含 OneApi 的所有地址设置,可自己修改地址映射或添加 Controller 逻辑。conf.properties
包含所的有 OneApi 设置项,需要根据业务场景进行修改。example.sql
和hello.sql
两个简单的接口示例文件。在已有的 Spring Boot 项目中使用 OneApi 非常容易,只需要两步操作,然后就可以开发接口了。
OneApi 的依赖和 PQL 是同一个依赖,参见使用 PQL 中关于依赖的配置内容。
新建一个类并添加@RestController
注解,也可以使用现有的 RestController 类。在类中添加一个方法:
上例中类名ApiController
和地址映射的路径/api/
可以根据需要命名,其他地方无需要修改。
在 resources 目录下新建文件夹api
,然后新建文件example.sql
。打开example.sql
,然后添加以下内容:
这个接口就完成了,运行项目,可以浏览器中输入接口地址http://localhost:8080/api/example/test
(端口根据你的项目设置确定)查看结果。在示例项目中已经有这个接口。