OneApi 快速入门

运行环境

OneApi 基于 Spring Boot 框架运行,通过依赖的方式引入到 Java Web 项目中。和其他方式开发的接口一样通过 HTTP 方式调取,OneApi 只是一种新的接口内容的开发方式,并不改变 Spring Boot 的任何东西。

从示例项目快速开始

示例项目源码地址:

https://github.com/qross-io/OneApi

示例项目的环境要求如下:

作者建议使用Intellij Idea作为 PQL 的开发环境,需要Intellij Idea 2018或以上版本。

示例项目中已经预先添加了一些文件和配置:

将 OneApi 加入到已有的项目中

在已有的 Spring Boot 项目中使用 OneApi 非常容易,只需要两步操作,然后就可以开发接口了。

引入 OneApi 依赖

OneApi 的依赖和 PQL 是同一个依赖,参见使用 PQL 中关于依赖的配置内容。

添加 RestController

新建一个类并添加@RestController注解,也可以使用现有的 RestController 类。在类中添加一个方法:

上例中类名ApiController和地址映射的路径/api/可以根据需要命名,其他地方无需要修改。

创建第一个接口

在 resources 目录下新建文件夹api,然后新建文件example.sql。打开example.sql,然后添加以下内容:

这个接口就完成了,运行项目,可以浏览器中输入接口地址http://localhost:8080/api/example/test(端口根据你的项目设置确定)查看结果。在示例项目中已经有这个接口。

获取更多信息


微信公众号
码农老吴  |  星源工作室  |  开发月志  |  问题反馈
联系我们:wu@qross.io     手机/微信:18618171102
京 ICP 备 20027445 号
$(h1)!