Skip to content

Commit 8937b3b

Browse files
committed
change README.md
1 parent 3ebe5eb commit 8937b3b

File tree

2 files changed

+63
-10
lines changed

2 files changed

+63
-10
lines changed

.github/workflows/release.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ jobs:
3737
- name: Refresh Proxy Go Package
3838
run: |
3939
TAG_NAME=${GITHUB_REF#refs/tags/}
40-
curl -v https://proxy.golang.org/${{ github.repository }}/goctlx/@v/$TAG_NAME.info
40+
curl -v https://proxy.golang.org/github.com/${{ github.repository }}/@v/$TAG_NAME.info

README.md

+62-9
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,72 @@
11
# goctlx
22

3-
## install
3+
`goctlx` 是基于 [go-zero](https://github.com/zeromicro/go-zero)
4+
的增强版脚手架工具,针对实际开发需求进行了深度定制。本项目优化了默认模板、文件生成逻辑和目录结构,并添加了便捷功能。
45

6+
---
7+
8+
## 🛠️ 主要修改与功能
9+
10+
### **目录结构优化**
11+
12+
- 重构 `handler``logic` 生成逻辑,更符合分层架构。
13+
- 调整 `template` 模板细节,生成代码更简洁规范。
14+
15+
### **功能增强**
16+
17+
- **智能读取 `.api` 文件**
18+
自动以当前父级文件夹名称作为 `.api` 文件的默认来源,减少路径参数输入。
19+
- **默认导出到当前目录**
20+
生成的代码默认输出到当前文件夹,简化命令操作。
21+
- **集成 `logic new` 逻辑**
22+
支持快速生成业务逻辑层代码,提升开发效率。
23+
24+
---
25+
26+
## 📦 安装方式
27+
28+
通过以下命令一键安装:
29+
30+
```bash
531
go install github.com/dxc0522/goctlx@latest
32+
```
33+
34+
---
35+
36+
## 🚀 快速使用
37+
38+
### **生成 Go API 服务**
39+
40+
在命令中运行:
41+
42+
```bash
43+
goctlx api new demo # 自动生成基于go-zero框架的api服务
44+
```
45+
46+
### **生成 API 服务**
47+
48+
1. 在包含 `.api` 文件的目录中运行:
649

7-
## 差异
50+
```bash
51+
goctlx api go # 自动读取[父级文件夹名称].api文件并生成代码到当前文件夹
52+
```
853

9-
修改逻辑及部分页面结构
10-
剔除单独的context设置
54+
---
1155

12-
### api
56+
## 📁 目录结构
1357

14-
* 生成api以当前父级文件夹的名称读取.api文件
15-
* 导出文件夹默认为当前文件夹
58+
```plaintext
59+
demo/
60+
├── config/
61+
├── etc/
62+
├── handler/
63+
├── logic/
64+
├── svc/
65+
├── types/
66+
├── demo.api
67+
└── demo.go
68+
```
1669

17-
## document
70+
## 📄 许可证
1871

19-
Read document at https://go-zero.dev/docs/tutorials/cli/overview
72+
本项目基于 [MIT License](LICENSE) 开源,可自由使用和修改。

0 commit comments

Comments
 (0)