zero

gin-zero

🤷‍ What is gin-zero?

English | 简体中文

gin-zero is a gin-based golang application scaffolding that supports one-click generation of HTTP, GRPC, Websocket applications, and can also be used to build microservice applications. It integrates many excellent open source packages internally, and also provides some modular microservices governance packages.

gin-zero contains simple API description syntax and code generation tool called ginctl.

Quick start

1. An example of http application: demo
2. Install

git clone https://github.com/gin-ctl/zero
cd zero
go install github.com/gin-ctl/ginctl@latest
ginctl -h
# example
ginctl apply --app admin --module http # A command generates the admin application of the http request
ginctl api -a admin -m http -l user -o ping -d test # Generate an http request interface 'ping' for the user module in the admin application
# Then go to the route directory and fill in your request method for the ping interface

1. Directory description

• app: application directory contains http, grpc, and websocket
• Application directory

app/http/demo
├── demo.go # main.go
├── deploy  # deployment document
│   ├── DockerFile
│   ├── Makefile
│   ├── certificate.yaml # Subscribe to ssl encrypted files for domain names for free
│   ├── gateway.yaml     # Kubernetes gateway configuration file
│   └── k8s.yaml         # Kubernetes deployment file
├── etc
│   └── env.yaml         # Modify your application configuration
├── logic
│   ├── demo             # Service code
│   │   ├── logic.go    # http request controller
│   │   └── types.go    # http request checksum request structure
│   └── logic.go
├── middleware  # middleware
│   └── auth.go
├── route  # Routing file
│   └── route.go
└── storage # Log file
    └── logs-2024-07-06.log

Code of Conduct

In order to ensure that the gin-zero community is welcoming to all, please review and abide by the [Code of Conduct](Code of Conduct).

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via golang2024@163.com. All security vulnerabilities will be promptly addressed.

License

The gin-zero framework is open-sourced software licensed under the MIT license.