You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-46
Original file line number
Diff line number
Diff line change
@@ -14,13 +14,15 @@
14
14
15
15
</div>
16
16
17
-
[sponge](https://github.com/zhufuyi/sponge) is a powerful tool for generating web and microservice code, a microservice framework based on gin and grpc encapsulation, and an open source framework for rapid application development. Sponge has a wealth of code generation commands, and different functional codes can be combined to form a complete service (similar to artificially scattered sponge cells that can automatically recombine into a new sponge). Microservice code functions include logging, service registration and discovery, registration center, flow control, fuse, link tracking, metric monitoring, pprof performance analysis, statistics, cache, CICD and other functions. Generate code unified in the UI interface operation, it is easy to build a complete project engineering code, allowing developers to focus on the implementation of the business logic code, without spending time and energy on the project configuration and integration.
17
+
[sponge](https://github.com/zhufuyi/sponge) is a powerful golang productivity tool that integrates `automatic code generation`, `microservices framework`, `general basic development framework`. sponge has a wealth of code generation commands to generate different functionality of the code can be combined into a complete service (similar to artificially scattered sponge cells that can automatically recombine into a new sponge). Code decoupling modular design , it is easy to build a complete project from development to deployment, so that you develop web or microservices project easily, golang can also be "low-code development".
18
18
19
19
<br>
20
20
21
21
### sponge generates the code framework
22
22
23
-
The generated code is based on three approaches **Yaml**, **SQL** and **Protobuf**, each possessing different functional code generation, and the framework diagram of the generated code is shown in Figure 1-1.
23
+
sponge is mainly based on **SQL** and **Protobuf** two ways to generate code, each way has to generate code for different functions.
The sponge separates the two major parts of code during the process of generating web service code. It isolates the business logic from the non-business logic. For example, consider the entire web service code as an egg. The eggshell represents the web service framework code, while both the albumen and yolk represent the business logic code. The yolk is the core of the business logic (manually written code). It includes defining MySQL tables, defining API interfaces, and writing specific logic code.On the other hand, the albumen acts as a bridge connecting the core business logic code to the web framework code (automatically generated, no manual writing needed). This includes the registration of route codes generated from proto files, handler method function codes, parameter validation codes, error codes, Swagger documentation, and more.
42
+
### Services framework
43
43
44
-
The web service egg model dissection diagram is shown in the following figure:
44
+
sponge generated microservice code framework is shown in the figure below, which is a typical microservice hierarchical structure, with high performance, high scalability, contains commonly used service governance features, you can easily replace or add their own service governance features.
The sponge separates the two major parts of code during the process of generating web service code. It isolates the business logic from the non-business logic. For example, consider the entire web service code as an egg. The eggshell represents the web service framework code, while both the albumen and yolk represent the business logic code. The yolk is the core of the business logic (manually written code). It includes defining MySQL tables, defining API interfaces, and writing specific logic code.On the other hand, the albumen acts as a bridge connecting the core business logic code to the web framework code (automatically generated, no manual writing needed). This includes the registration of route codes generated from proto files, handler method function codes, parameter validation codes, error codes, Swagger documentation, and more.
59
56
60
-
The rpc gateway service egg model dissection is shown in the following figure:
57
+
Egg model profiling diagram for `⓷Web services created based on protobuf`:
The microservice code framework created by sponge is shown in Figure 1-2, this is a typical microservice hierarchy with high performance, high scalability, and includes common service governance features.
This is the egg model for web service code, and there are egg models for microservice (gRPC) code, and rpc gateway service code described in [sponge documentation](https://go-sponge.com/).
76
64
77
65
<br>
78
66
79
-
### Installation
80
-
81
-
-[Install sponge in linux or macOS](https://github.com/zhufuyi/sponge/blob/main/assets/install-en.md#install-sponge-in-linux-or-macos)
82
-
-[Install sponge in windows](https://github.com/zhufuyi/sponge/blob/main/assets/install-en.md#install-sponge-in-windows)
67
+
### Quick start
83
68
84
-
<br>
69
+
**Installation sponge:**
85
70
86
-
### Quick start
71
+
sponge can be installed on Windows, macOS, and Linux environments. Click here to view [Installation Instructions](https://github.com/zhufuyi/sponge/blob/main/assets/install-en.md).
87
72
88
73
After installing the sponge, start the UI service:
89
74
@@ -95,11 +80,15 @@ Visit `http://localhost:24631` in your browser, generate code by manipulating it
95
80
96
81
<br>
97
82
98
-
### Examples of use
83
+
### Documentation
99
84
100
-
The following sample code , in addition to the core business logic code , the other code is generated by the tool sponge .
85
+
[sponge documentation](https://go-sponge.com/)
101
86
102
-
#### Basic Services examples
87
+
<br>
88
+
89
+
### Examples of use
90
+
91
+
#### Simple examples (excluding business logic code)
0 commit comments