Lite API Lite API
首页
指南
API
更新日志
Gitee (opens new window)
  • 简体中文
  • English
首页
指南
API
更新日志
Gitee (opens new window)
  • 简体中文
  • English

Lite API

基于 JFinal 的轻量级、敏捷 API 开发框架

开始使用 →

零代码开发

无需定义传统的 Controller、Service、Dao 或 Model 类即可开发 HTTP API。

可视化界面测试

内置在线测试界面,便于 API 开发和调试。

多数据库支持

支持 MySQL、PostgreSQL、Oracle 等数据库,具有动态数据源配置。

动态脚本

使用动态脚本编写业务逻辑,支持即时重载功能。

高性能

基于 JFinal 5.x 构建,提供卓越的性能和开发效率。

易于部署

简单的打包和部署,只需最少的配置。

零代码开发

无需定义传统的 Controller、Service、Dao 或 Model 类即可开发 HTTP API。

可视化界面测试

内置在线测试界面,便于 API 开发和调试。

多数据库支持

支持 MySQL、PostgreSQL、Oracle 等数据库,具有动态数据源配置。

动态脚本

使用动态脚本编写业务逻辑,支持即时重载功能。

高性能

基于 JFinal 5.x 构建,提供卓越的性能和开发效率。

易于部署

简单的打包和部署,只需最少的配置。

# 什么是 Lite API?

Lite API 是一个基于 JFinal 构建的轻量级、敏捷的 API 开发框架。它允许开发者在不编写传统的 Controller、Service、Dao 或 Model 类的情况下创建 HTTP API。API 使用 XML 配置文件和嵌入式脚本逻辑来定义。

# 核心特性

# 零代码开发

无需编写 Java 代码即可创建 API。使用 XML 配置文件定义 API,并使用动态脚本实现业务逻辑。

# 可视化界面测试

内置在线测试界面,无需外部工具即可轻松开发和调试 API。

# 多数据库支持

支持多种数据库,包括 MySQL、PostgreSQL、Oracle 等,具有动态数据源配置。

# 动态脚本

使用可即时重载的动态脚本编写业务逻辑,无需重新启动服务器。

# 高性能

基于 JFinal 5.x 构建,提供卓越的性能和开发效率。

# 快速开始

# 克隆仓库
git clone https://gitee.com/xc_java/lite-api.git

# 导航到服务演示目录
cd xclite-api/xclite-service/xclite-service-demo

# 启动服务
./lite.sh start
1
2
3
4
5
6
7
8

API 服务将在 http://localhost:8088 上可用。

在线测试界面可通过 http://localhost:8088/debug/index.html 访问。

# 示例 API

以下是一个返回用户列表的简单 API 示例:

<?xml version="1.0" encoding="UTF-8"?>
<api-group id="lite_users" name="用户管理" path="/api/lite_users">
    <api id="list" method="GET" name="列出用户" path="/">
        <script><![CDATA[
            return db.select("SELECT * FROM lite_users");
        ]]></script>
    </api>
    
    <api id="get" method="GET" name="获取用户" path="/{id}">
        <script><![CDATA[
            var user = db.selectOne("SELECT * FROM lite_users WHERE id = #{id}");
            
            if (user==null) {
                exit 404,"用户未找到";
            }
            
            return user;
        ]]></script>
    </api>
</api-group>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 为什么选择 Lite API?

  1. 快速开发:无需编写样板代码即可在几分钟内创建 API
  2. 灵活性:无需重新编译即可轻松修改和扩展 API
  3. 数据库无关性:适用于多种数据库系统
  4. 内置测试:无需外部工具即可测试您的 API
  5. 轻量级:最小的开销和快速的启动时间
  6. JFinal 集成:利用 JFinal 的强大功能和简洁性

# 文档

  • 安装指南 - 了解如何安装和设置 Lite API
  • 快速开始 - 在几分钟内创建您的第一个 API
  • API 参考 - 所有 API 组件的详细文档
  • 示例 - 实践示例帮助您入门

# 语言版本

  • 中文 - 默认语言 (推荐)
  • English - 英文版本

# 社区

  • Gitee Issues (opens new window) - 报告错误或请求功能
Theme by Vdoing
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式