Skip to content

Commit 4dc87b0

Browse files
committed
README.md
1 parent 1a402d4 commit 4dc87b0

File tree

6 files changed

+86
-2
lines changed

6 files changed

+86
-2
lines changed

README.md

Lines changed: 86 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
#### v1.0.0
44

5-
![首页](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/main.png)
5+
![alt 首页](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/mainv1.png)
66

77
### 简介
88

@@ -21,16 +21,100 @@
2121
- swaggo [https://github.com/swaggo/swag](https://github.com/swaggo/swag)
2222

2323
### 自动加载配置
24+
![alt 启动前](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/folder-1.png)
2425

26+
```
2527
项目启动的时候会自动创建配置文件夹
2628
2729
自动加载默认配置文件到 /resource 下
2830
2931
font/ 字体文件
3032
temp/ 模板文件
3133
conf.yaml 默认配置文件
34+
```
35+
![alt 启动后2](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/folder-2.png)
36+
37+
![alt 启动后3](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/folder-3.png)
38+
39+
![alt 启动后4](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/folder-4.png)
40+
41+
42+
### 设置-数据库配置
43+
44+
![alt 数据库配置](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/set-database.png)
45+
46+
```
47+
输入对应的数据库配置
48+
49+
点击测试,成功
50+
51+
会自动保存到配置文件,下次打开程序自动读取数据库配置
52+
```
53+
54+
### 设置-项目配置
55+
56+
![alt 项目配置](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/set-project.png)
57+
58+
##### 项目名称
59+
```
60+
只用于展示
61+
```
62+
##### mod名称
63+
```
64+
填写项目go.mod中 module名称,用于生成代码时import的前缀
65+
```
66+
67+
##### 模块缩写
68+
```
69+
模块的名称,用于生成代码的层级文件夹,跟import路径
70+
71+
```
72+
##### 路由前缀
73+
```
74+
生成接口的前缀
75+
76+
```
77+
78+
### 生成器-代码生成
79+
![alt 代码生成](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/code-gen.png)
80+
81+
![alt 代码生成](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/code-gen-2.png)
82+
83+
```
84+
如果数据库测试成功,切换到“代码生成”页面,会自动列出来数据库所有的表
85+
点击选择表
86+
可以数据搜索的表名,模糊搜索,自动选择搜索到的第一张表
87+
点击生成就会按照配置的生成golang 代码
88+
```
89+
![alt 代码生成](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/code-gen-3.png)
90+
91+
92+
93+
### 例子
94+
95+
使用我自己搭建的简单 Golang 框架
96+
97+
目录结构
98+
99+
![alt 目录结构](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/demo-1.png)
100+
101+
我的配置项是这样的
102+
103+
![alt 配置](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/demo-2.png)
104+
105+
选择test表,点击生成,生成对应的代码
106+
107+
![alt 代码](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/demo-3.png)
108+
109+
![alt 代码](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/demo-4.png)
110+
111+
把代码拷贝到自己的项目,运行一下代码
112+
113+
已经有新的接口了
114+
115+
![alt 代码](https://raw.githubusercontent.com/sunzhonghui/go-code-generator/master/resource/images/demo-5.png)
116+
32117

33-
### 配置
34118

35119

36120

resource/images/demo-1.png

13.2 KB
Loading

resource/images/demo-2.png

22.5 KB
Loading

resource/images/demo-3.png

12.6 KB
Loading

resource/images/demo-4.png

6.09 KB
Loading

resource/images/demo-5.png

22.9 KB
Loading

0 commit comments

Comments
 (0)