Browse Source

update README.md.

小东 5 years ago
parent
commit
2879728042
1 changed files with 75 additions and 1 deletions
  1. 75 1
      README.md

+ 75 - 1
README.md

@@ -1,5 +1,5 @@
 <p align="center">
-    <img src="http://www.ssssssss.org/images/logo.png" width="600">
+    <img src="https://images.gitee.com/uploads/images/2020/0505/095241_408bc438_297689.png" width="600">
 </p>
 <p align="center">
     <a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html"><img src="https://img.shields.io/badge/JDK-1.8+-green.svg" /></a>
@@ -13,3 +13,77 @@
     <a target="_blank" href="LICENSE"><img src="https://img.shields.io/:license-MIT-blue.svg"></a>
     <a target="_blank" href="https://shang.qq.com/wpa/qunwpa?idkey=10faa4cf9743e0aa379a72f2ad12a9e576c81462742143c8f3391b52e8c3ed8d"><img src="https://img.shields.io/badge/Join-QQGroup-blue"></a>
 </p>
+
+# 特性
+-  以XML为基础,自动映射HTTP接口
+-  支持MySQL、MariaDB、Oracle、DB2、PostgreSQL、SQLServer 等多种数据库
+-  支持参数自动校验以及自定义参数校验
+-  支持分页查询以及自定义分页查询
+-  支持XML中调用java方法
+-  支持执行多条sql语句
+-  自动热更新
+-  ~~支持单表自动映射CRUD~~
+-  ~~支持缓存~~
+-  ~~支持多数据源~~
+-  ~~支持主键自动生成,可自定义配置主键生成策略(正在开发中)~~
+-  ~~支持调用存储过程~~
+
+# 快速开始
+
+## maven引入
+```xml
+<!-- 以spring-boot-starter的方式引用 -->
+<dependency>
+	<groupId>org.ssssssss</groupId>
+	<artifactId>ssssssss-spring-boot-starter</artifactId>
+    <version>0.0.1</version>
+</dependency>
+```
+## 修改application.properties
+
+```properties
+server.port=9999
+#配置ssssssss的xml所在位置
+ssssssss.xml-locations: classpath*:ssssssss/*.xml
+#以下配置需跟实际情况修改
+spring.datasource.url=jdbc:mysql://localhost/test
+spring.datasource.username=root
+spring.datasource.password=123456789
+spring.datasource.driver-class-name=com.mysql.jdbc.Driver
+```
+
+## 创建XML
+
+在`src/main/resources/ssssssss/`下建立`user.xml`文件
+```xml
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE ssssssss PUBLIC "-//ssssssss.org//DTD ssssssss 0.1//EN" "http://ssssssss.org/dtd/0.0.x/ssssssss.dtd">
+<ssssssss request-mapping="/user">
+    <!-- 访问地址/user/list,访问方法get,并开启分页 -->
+    <select-list request-mapping="/list" request-method="get" page="true">
+        select username,password from sys_user
+    </select-list>
+</ssssssss>
+```
+
+## 测试
+访问`http://localhost:9999/user/list`
+
+结果如下:
+```json
+{
+	"code": 1,
+	"message": "success",
+	"data": {
+		"total": 2,
+		"list": [{
+			"password": "123456",
+			"username": "admin"
+		}, {
+			"password": "1234567",
+			"username": "1234567"
+		}]
+	},
+	"timestamp": 1588586539249
+}
+```