Skip to content

Commit 2e8fe43

Browse files
committed
update:readme and docment
1 parent de40c79 commit 2e8fe43

File tree

4 files changed

+18
-78
lines changed

4 files changed

+18
-78
lines changed

README.en.md

Lines changed: 9 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Support privatization deployment, free, safe, open source, controllable
1919

2020
## Software feature
2121
1. permission verication
22-
2. support ip address location information query(IPV4 and IPV6)
22+
2. support ip address location information query
2323
3. support ID verification and information query
2424
4. support phone number information query
2525
5. Weather forecast (planned)
@@ -40,10 +40,11 @@ Support privatization deployment, free, safe, open source, controllable
4040
20. Metering Conversion
4141
21. CDKey Creator
4242
22. Distributed lock
43-
23. short url creator
43+
23. short url creator(planned)
4444
24. local system time
4545
25. math Calculation
46-
26. log service(plan)
46+
26. log service
47+
27. Plugin hot reload(planned)
4748

4849
## install
4950

@@ -58,13 +59,17 @@ window Exection XEngine_WINEnv.bat
5859
Linux Exection:sudo ./XEngine_LINEnv.sh -i 3
5960
Macos Exection:./XEngine_LINEnv.sh -i 3
6061

62+
#### Database Env
63+
MYSQL database version 8.0 or above is required. Create a table through CreateDatabase.sql, and then import the table with XEngine_APIInfo.sql
64+
Modify the database configuration in XSQL in the configuration file to your
65+
6166
#### Windows
6267
need to vcpkg configure third-part env.refer vcpkg install guide.after installed and execution:vcpkg.exe install lua lua:x64-windows opencc opencc:x64-windows
6368
use vs open and compile,suport windows 7sp1 and above
6469
Just Run it
6570

6671
#### Linux
67-
install opencc,ubuntu:sudo apt install libopencc-dev
72+
ubuntu:sudo apt install libopencc-dev
6873
centos:compile by self
6974
use makefile compile,UBUNTU20.04 x64 or CENTOS8 x64
7075
Run it on the terminal
@@ -111,41 +116,6 @@ You can refer to the document under the docment directory. It contains API proto
111116
Address:app.xyry.org,Port:5501
112117
#### example
113118
For more information please refer to the documentation
114-
phone information query
115-
api:http://app.xyry.org:5501/api?function=phone&params1=13699439999
116-
```json
117-
{
118-
"code":0,
119-
"data":{
120-
"nAreaCode":28,
121-
"nPhoneNumber":13699439999,
122-
"nZipCode":610000,
123-
"tszCity":"成都",
124-
"tszProvincer":"四川"
125-
},
126-
"msg":"success"
127-
}
128-
```
129-
ip address information
130-
api:http://app.xyry.org:5501/api?function=ip&params1=1.29.164.255
131-
```json
132-
{
133-
"code":0,
134-
"data":{
135-
"tszIPAddr":"1.29.164.255",
136-
"tszIPAddress":"内蒙古通辽市霍林郭勒市",
137-
"tszIPCity":"通辽市",
138-
"tszIPCountry":"中国",
139-
"tszIPCounty":"霍林郭勒市",
140-
"tszIPEnd":"1.29.164.255",
141-
"tszIPISP":"联通",
142-
"tszIPProvince":"内蒙古",
143-
"tszIPStart":"1.29.164.0",
144-
"tszIPTime":"2021-11-03 07:33:50"
145-
},
146-
"msg":"success"
147-
}
148-
```
149119
id information query
150120
api:http://app.xyry.org:5501/api?function=id&params1=511025198800000000
151121
```json

README.md

Lines changed: 9 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ c c++ interface api service
1919

2020
## 软件特性
2121
1. 权限验证
22-
2. 支持IP地址位置信息查询(IPV4和IPV6)
22+
2. 支持IP地址位置信息查询
2323
3. 支持身份证校验与信息查询
2424
4. 支持手机号信息归属查询
2525
5. 天气预报(计划中)
@@ -40,10 +40,11 @@ c c++ interface api service
4040
20. 计量转换
4141
21. CDKey创建支持
4242
22. 分布式锁API
43-
23. 短连接生成
43+
23. 短连接生成(计划中)
4444
24. 本地标准时间
4545
25. 数学计算
46-
26. 日志服务(计划中)
46+
26. 日志服务
47+
27. 插件脚本热重载(计划中)
4748

4849
## 安装教程
4950

@@ -58,13 +59,17 @@ window执行XEngine_WINEnv.bat 脚本.
5859
Linux执行:sudo ./XEngine_LINEnv.sh -i 3
5960
macos执行:./XEngine_LINEnv.sh -i 3
6061

62+
#### 数据库环境
63+
需要MYSQL数据库8.0以上版本.通过CreateDatabase.sql创建表,然后XEngine_APIInfo.sql导入表
64+
修改配置文件里面XSQL里面的数据库配置为你的
65+
6166
#### Windows
6267
需要vcpkg配置第三方环境,具体参考vcpkg安装方式,安装好后执行:vcpkg.exe install lua lua:x64-windows opencc opencc:x64-windows
6368
使用VS打开并且编译,支持WINDOWS 7SP1以上系统
6469
直接运行即可
6570

6671
#### Linux
67-
安装opencc,ubuntu:sudo apt install liblua5.3-dev libopencc-dev
72+
ubuntu:sudo apt install liblua5.3-dev libopencc-dev
6873
centos:需要自己编译
6974
Linux使用Makefile编译,UBUNTU20.04 x64或者CENTOS8 x64
7075
在控制台运行
@@ -109,41 +114,6 @@ make FLAGS=CleanAll 清理编译
109114

110115
#### 测试接口示例
111116
更多内容请参考文档
112-
手机信息查询
113-
接口:http://app.xyry.org:5501/api?function=phone&params1=13699439999
114-
```json
115-
{
116-
"code":0,
117-
"data":{
118-
"nAreaCode":28,
119-
"nPhoneNumber":13699439999,
120-
"nZipCode":610000,
121-
"tszCity":"成都",
122-
"tszProvincer":"四川"
123-
},
124-
"msg":"success"
125-
}
126-
```
127-
IP地址查询
128-
接口:http://app.xyry.org:5501/api?function=ip&params1=1.29.164.255
129-
```json
130-
{
131-
"code":0,
132-
"data":{
133-
"tszIPAddr":"1.29.164.255",
134-
"tszIPAddress":"内蒙古通辽市霍林郭勒市",
135-
"tszIPCity":"通辽市",
136-
"tszIPCountry":"中国",
137-
"tszIPCounty":"霍林郭勒市",
138-
"tszIPEnd":"1.29.164.255",
139-
"tszIPISP":"联通",
140-
"tszIPProvince":"内蒙古",
141-
"tszIPStart":"1.29.164.0",
142-
"tszIPTime":"2021-11-03 07:33:50"
143-
},
144-
"msg":"success"
145-
}
146-
```
147117
身份证查询
148118
接口:http://app.xyry.org:5501/api?function=id&params1=511025198800000000
149119
```json

XEngine_Docment/Docment_en.docx

955 Bytes
Binary file not shown.

XEngine_Docment/Docment_zh.docx

2.04 KB
Binary file not shown.

0 commit comments

Comments
 (0)