mirror of
https://github.com/xinliangnote/go-gin-api.git
synced 2024-04-21 12:31:46 +00:00
37 lines
2.0 KiB
Markdown
37 lines
2.0 KiB
Markdown
## What is go-gin-api?
|
||
|
||
`go-gin-api` is a modular design API framework based on [Gin](https://github.com/gin-gonic/gin), which encapsulates commonly used functions, is simple to use, and is committed to fast business Research and development, while adding more restrictions, restrict the development members of the project team, avoid chaos, disorder and free and arbitrary coding.
|
||
|
||
For reference and learning at this stage, please be cautious when using it in a production environment!
|
||
|
||
Features:
|
||
1. Rate-limitd APIs supported by [rate](https://golang.org/x/time/rate)
|
||
1. Email notification when panic occurs
|
||
1. Cross-Origin Resource Sharing supported by [cors](https://github.com/rs/cors)
|
||
1. Metrics monitoring and alerting by [Prometheus](https://github.com/prometheus/client_golang)
|
||
1. Automatically generate RESTful API documentation supported by [Swagger](https://github.com/swaggo/gin-swagger)
|
||
1. GraphQL supported by [GraphQL](https://github.com/99designs/gqlgen)
|
||
1. Trace project internal invoking
|
||
1. Visualized performance analysis supported by [pprof](https://github.com/gin-contrib/pprof)
|
||
1. Uniformly defined error codes supported by errno
|
||
1. Blazing fast, structured, leveled logging system by [zap](https://go.uber.org/zap)
|
||
1. Complete configuration solution supported by [viper](https://github.com/spf13/viper)
|
||
1. Developer Friendly ORM library supported by [gorm](https://gorm.io/gorm)
|
||
1. Redis supported by [go-redis](https://github.com/go-redis/redis)
|
||
1. Standard RESTful API return value
|
||
1. CURD code generator , controller generator, etc.
|
||
1. Web interface, supported by [Light Year Admin template](https://gitee.com/yinqi/Light-Year-Admin-Using-Iframe)
|
||
|
||
|
||
|
||
## Index
|
||
|
||
**Detailed documentation：[https://www.yuque.com/xinliangnote/go-gin-api/ngc3x5](https://www.yuque.com/xinliangnote/go-gin-api/ngc3x5)**
|
||
|
||
## Contributing
|
||
|
||
Help us with translating `go-gin-api` to your native language.
|
||
|
||
## Learning together
|
||
|
||
 |