Help for MyRestServerV2 Docker
此版本与之前版本已经有了本质的区别，为全新架构设计，并且使用了.net 6技术，因此得以兼容Docker 和 Linux。 但秉承了一贯轻量，简单易用的原则。并且拥有比旧版更多的功能。目前更多的功能依然正在不断完善之中。
docker pull devgis/myrestserverv2
也是很简单的直接运行以下docker命令
docker run --net=host -v {localconfigpath}/appsettings.json:/app/appsettings.json:ro -v {localconfigpath}/nlog.config:/app/nlog.config:ro -v {localconfigpath}/server.pfx:/app/server.pfx:ro -v {locallogpath}:/app/logs --privileged=true -e ASPNETCORE_ENVIRONMENT=Development -e ASPNETCORE_URLS="https://+:7011;http://+:7001" -e ASPNETCORE_Kestrel__Certificates__Default__Password=147258369 -e ASPNETCORE_Kestrel__Certificates__Default__Path=/app/server.pfx myrestserverv2
{localconfigpath} 是用于存放本地配置的目录，按自己实际情况修改即可。
{locallogpath} 是用于存放本地日志的目录 ，按自己实际情况修改即可。
appsettings.json主配置文件
nlog.config 是nlog配置文件
server.pfx是证书文件 可以自己生成，用于部署https,如果不需要https则是不需要的。
docker-compose up -d
默认http端口为 7001 https 端口为 7011，可以按照自己的实际情况进行修改。
可以直接在浏览器中打开https:///{dockerip}:7011/ 查看相关信息
可以在 https:///{dockerip}:7011/swagger/index.html中查看配置文件
本目录下已经存在相关配置文件docker-compose.yml：
version: '3.4'
services:
webapp:
image: myrestserverv2
network_mode: "host"
privileged: true
restart: always
environment:
- ASPNETCORE_ENVIRONMENT=Development
- ASPNETCORE_URLS=https://+:7011;http://+:7001
- ASPNETCORE_Kestrel__Certificates__Default__Password=147258369
- ASPNETCORE_Kestrel__Certificates__Default__Path=/app/server.pfx
volumes:
- {localconfigpath}/appsettings.json:/app/appsettings.json:ro
- {localconfigpath}/nlog.config:/app/nlog.config:ro
- {localconfigpath}/server.pfx:/app/server.pfx:ro
- {locallogpath}:/app/logs
{localconfigpath} 是用于存放本地配置的目录
{locallogpath} 是用于存放本地日志的目录
appsettings.json主配置文件
nlog.config 是nlog配置文件
server.pfx是证书文件 可以自己生成，用于部署https,如果不需要https则是不需要的。
docker-compose up -d
默认http端口为 7001 https 端口为 7011，可以按照自己的实际情况进行修改。
可以直接在浏览器中打开https:///{dockerip}:7011/ 查看相关信息
可以在 https:///{dockerip}:7011/swagger/index.html中查看配置文件
appsettings.json
主要在以下部分
"DEVGIS":{
"DBType":"MYSQL", //数据库类型 Access "OLEDB","ACCESS"， SQLServer : "MSSQL","MSSQLSERVER","SQLSERVER" MYSQL:"MYSQL" Oracle:"ORACLE" Postgresql:"POSTGRESQL","POSTGRES" 如果不能识别则认为是Access数据库
"Tables":["t_test","t_role"],//手动配置开放的表，如果此项为空则使用数据库检索
"FilterTables":["t_user","t_sys"],//需要过滤的表
"Views":["v_test","v_null"], //视图
"Procedures":["sp_test1","sp_test2"], //视图
"Addable":true, //允许添加数据
"Updateable":true, //允许修改
"DeleteAble":true, //允许删除
"AllowExecuteProcedures":true //允许执行存储过程
},
"ConnectionStrings": {
"WebApiDatabase": "server=localhost;port=33306;database=test_db;user=root;password=123456;SslMode=None;allowPublicKeyRetrieval=true;" 为数据库连接字符串配置
},
nlog.config
具体参考网络上关于nlog的配置
{
"AllowedHosts": "*",
"DEVGIS":{
"DBType":"MYSQL", //数据库类型 Access "OLEDB","ACCESS"， SQLServer : "MSSQL","MSSQLSERVER","SQLSERVER" MYSQL:"MYSQL" Oracle:"ORACLE" Postgresql:"POSTGRESQL","POSTGRES" 如果不能识别则认为是Access数据库
"Tables":["t_test","t_role"],//手动配置开放的表，如果此项为空则使用数据库检索
"FilterTables":["t_user","t_sys"],//需要过滤的表
"Views":["v_test","v_null"], //视图
"Procedures":["sp_test1","sp_test2"], //视图
"Addable":true, //允许添加数据
"Updateable":true, //允许修改
"DeleteAble":true, //允许删除
"AllowExecuteProcedures":true //允许执行存储过程
},
"ConnectionStrings": {
"WebApiDatabase": "server=localhost;port=33306;database=test_db;user=root;password=123456;SslMode=None;allowPublicKeyRetrieval=true;"
},
"Jwt": {
"SecretKey": "test@test.com_____________________",
"Issuer": "WebAppIssuer",
"Audience": "WebAppAudience"
},
"Logging": {
"LogLevel": {
"Default": "Information",
"System": "Warning",
"Microsoft": "Warning",
"Microsoft.AspNetCore": "Warning",
"Hangfire": "Warning"
},
"NLog": {
"IncludeScopes": true //true启用nlog ，false 禁用
}
}
}
<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd"
autoReload="true"
throwExceptions="false"
internalLogLevel="Off" internalLogFile="logs/nlog-internal.log">
<!--${basedir}/logs-->
<variable name="logDirectory" value="logs"/>
<variable name="traceVal" value="${date:format=HH\:mm\:ss} [Thread-${threadname:whenEmpty=${threadid}}]|${message}"/>
<variable name="layoutVal" value="${date:format=HH\:mm\:ss} [Thread-${threadname:whenEmpty=${threadid}}]|${uppercase:${level}}|${callsite:fileName=True}${newline}${message}${newline}${exception}"/>
<variable name="consoleVal" value="${date:format=HH\:mm\:ss}|${pad:padding=5:inner=${level:uppercase=true}}|${message}"/>
<targets>
<target name="console" xsi:type="ColoredConsole" useDefaultRowHighlightingRules="false"
layout="${consoleVal}" >
<highlight-row condition="level == LogLevel.Debug" foregroundColor="DarkGray" />
<highlight-row condition="level == LogLevel.Info" foregroundColor="Gray" />
<highlight-row condition="level == LogLevel.Warn" foregroundColor="Yellow" />
<highlight-row condition="level == LogLevel.Error" foregroundColor="Red" />
<highlight-row condition="level == LogLevel.Fatal" foregroundColor="Red" backgroundColor="White" />
</target>
<target xsi:type="File"
name="logfile"
fileName="${logDirectory}/info_${shortdate}.log"
keepFileOpen="false"
layout="${layoutVal}" />
<target xsi:type="File"
name="warnfile"
fileName="${logDirectory}/warn_${shortdate}.log"
keepFileOpen="false"
layout="${layoutVal}" />
<target xsi:type="File"
name="errfile"
fileName="${logDirectory}/error_${shortdate}.log"
keepFileOpen="false"
layout="${layoutVal}" />
<target xsi:type="File"
name="debugfile"
fileName="${logDirectory}/debug_${shortdate}.log"
keepFileOpen="false"
layout="${layoutVal}" />
<target xsi:type="File"
name="tracefile"
fileName="${logDirectory}/trace_${shortdate}.log"
keepFileOpen="false"
layout="${traceVal}" />
</targets>
<rules>
<logger name="*" writeTo="console" />
<logger name="*" level="Trace" writeTo="tracefile"/>
<logger name="*" level="Error" writeTo="errfile" />
<logger name="*" level="Warn" writeTo="warnfile"/>
<logger name="*" minlevel="Info" writeTo="logfile"/>
<logger name="*" minlevel="Debug" writeTo="debugfile" />
</rules>
</nlog>
{
"DetailedErrors": true,
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
}
}
证书正常情况是找CA购买，但是本质上咱们自己生成的证书也能用，但是会被浏览器不识别。当然使用上是没有任何问题的，这里是Linux 下利用openssl生成证书的过程，windows下应该会更简单一些。这里只介绍ubuntu22下证书的生成。需要自己先安装Openssl。
openssl genrsa -des3 -out server.key 2048
openssl req -new -x509 -key server.key -out server.crt -days 18250
openssl pkcs12 -export -out server.pfx -inkey server.key -in server.crt
pass exportpassword 147258369 这里导出密钥就是我们在上面docker-compose.yml中或者docker命令启动环境中ASPNETCORE_Kestrel__Certificates__Default__Password=147258369中对应的密码。
/api/v 查看系统版本信息
api/info 查看程序详细信息
api/tables 查看当前库表名列表信息
api/{tablename}/full 或 api/{tablename}/info查看完整表格信息
示例 :https://localhost:7176/api/t_test/full 或 https://localhost:7176/api/t_test/info
api/{tablename}/count 查看当前表行数
支持querystring :where
api/{tablename}/all 查看表格中完整数据 Json形式
支持querystring :cols,where
api/{tablename}/top{count} 查看当前表格的列数据详细信息
示例 :https://localhost:7176/api/t_test/top5 查询前库5条数据
支持querystring :cols,where,ordercol,asc
https://localhost:7176/api/t_test/top1?cols=id,name&where=id%3C=2&ordercol=id&asc=true
分页查询 api/t_test/page/{PageSize}/{PageIndex}
支持querystring :cols,where
https://localhost:7176/api/t_test/page/2/1?cols=name&where=id > 0
支持querystring :where
api/{tablename}/add
示例参数(post content)：
{
"Parameters":[{"key":"id","value":99},{"key":"name","value":"testadd"},{"key":"remarks","value":"添加的"}]
}
api/{tablename}/update
示例参数(post content)：
{
"Parameter":{"name":"testadd991","remarks":"添加的991"},
"Condition":{"id":991}
}
api/{tablename}/delete
示例参数(post content)：
content-type:application/json
{
"Condition":{"id":10}
}
api/execute/{procedurename}
示例参数(post content)：
{
"Parameter":{"id":11,"name":"testadd22","remarks":"nn"}
}
这一部分可以参考Tests目录下的测试脚本。
api/views 查看当前库表名列表信息
api/{viewname}/full 或 api/{viewname}/info查看完整表格信息
示例 :https://localhost:7176/api/v/v_test/full 或 https://localhost:7176/api/v_test/info
api/{viewname}/count 查看当前表行数
支持querystring :where
api/{viewname}/all 查看表格中完整数据 Json形式
支持querystring :cols,where
api/{viewname}/top{count} 查看当前表格的列数据详细信息
示例 :https://localhost:7176/api/v/v_test/top5 查询前库5条数据
https://localhost:7176/api/v/v_test/top1?cols=name&where=Username like '%a%'
支持querystring :cols,where
分页查询 api/v/v_test/page/{PageSize}/{PageIndex}
支持querystring :cols,where,ordercol,asc
https://localhost:7176/api/v/v_test/page/10/2?cols=UserName&where=1=1&ordercol=id&asc=true
分页页数查询 api/v/v_test/page/{PageSize}
支持querystring :where
目前功能还不完善，后期将不断完善更新，欢迎大家关注，并给予反馈。
可以通过邮箱 devgis@qq.com 或者 devgis@163.com 与我留言， 也可以直接在github上反馈。