golang-gin-boilerplate
所属分类：MongoDB
开发工具：GO
文件大小：55KB
下载次数：0
上传日期：2022-05-30 07:56:02
上 传 者：
sh-1993
说明： Golang Gin Boilerplate With MongoDB for Rest Api果朗杜松子酒
(Golang Gin Boilerplate With MongoDB for Rest Api)
文件列表:
.air.toml (663, 2022-05-30)
.env.example (261, 2022-05-30)
Dockerfile (690, 2022-05-30)
LICENSE (1069, 2022-05-30)
art (0, 2022-05-30)
art\main.go (85, 2022-05-30)
config (0, 2022-05-30)
config\app.go (553, 2022-05-30)
config\db.go (387, 2022-05-30)
config\main.go (324, 2022-05-30)
config\mongo.go (409, 2022-05-30)
deployments (0, 2022-05-30)
deployments\stage-golang-gin-boilerplate-deployment.yml (2032, 2022-05-30)
docker-compose.yml (267, 2022-05-30)
docs (0, 2022-05-30)
docs\docs.go (7803, 2022-05-30)
docs\swagger.json (7140, 2022-05-30)
docs\swagger.yaml (3272, 2022-05-30)
go.mod (3436, 2022-05-30)
go.sum (103227, 2022-05-30)
main.go (755, 2022-05-30)
routes (0, 2022-05-30)
routes\main.go (2157, 2022-05-30)
src (0, 2022-05-30)
src\todo (0, 2022-05-30)
src\todo\controllers (0, 2022-05-30)
src\todo\controllers\todo_controller.go (4675, 2022-05-30)
src\todo\dto (0, 2022-05-30)
src\todo\dto\todo_dto.go (615, 2022-05-30)
src\todo\models (0, 2022-05-30)
src\todo\models\todo.go (598, 2022-05-30)
src\todo\routes (0, 2022-05-30)
src\todo\routes\api.go (366, 2022-05-30)
src\todo\services (0, 2022-05-30)
... ...
# golang-gin-boilerplate
Golang [Artifact](https://github.com/shipu/artifact) Boilerplate for Rest Api. It's based on [Gin](https://github.com/gin-gonic/gin)
create .env file if not exists in root directory:
```shell
cp .env.example .env
```
## For Generate Crud:
```go
go run ./art crud package_name crud_module_name
```
### Example:
Run
```go
go run ./art crud github.com/shipu/golang-gin-boilerplate notice
```
to generate crud.
Folder structure:
```go
src/notice
├── controllers
│ └── notice_controller.go
├── models
│ └── notice.go
├── routes
│ └── api.go
└── services
└── notice_service.go
```
#### For Register Routes:
In `routes/main.go`
```go
import (
...
...
...
noticeRoute "github.com/shipu/golang-gin-boilerplate/src/notice/routes"
)
```
```go
func Register() {
...
...
noticeRoute.NoticeSetup()
}
```
#### For Initialize Model Collection:
In `routes/main.go`
```go
import (
...
...
...
notice "github.com/shipu/golang-gin-boilerplate/src/notice/models"
)
```
```go
func Boot() {
...
...
notice.NoticeSetup()
}
```
Congratulation !!! You have successfully generated rest crud api.
Now you can run your application with `go run main.go` command or `air`.
Swagger Api Documentation: [http://localhost:8080/docs/index.html](http://localhost:8080/docs/index.html)
## Config :
Suppose your config is `config/mongo.go`:
```go
package config
type MongoConfig struct {
Username string `mapstructure:"MONGO_USER" default:""`
Password string `mapstructure:"MONGO_PASS" default:""`
Host string `mapstructure:"MONGO_HOST" default:""`
Port string `mapstructure:"MONGO_PORT" default:""`
Database string `mapstructure:"MONGO_DATABASE" default:""`
Connection string `mapstructure:"MONGO_CONNECTION" default:"mongodb"`
}
```
and your `.env` is:
```dotenv
MONGO_CONNECTION=mongodb
MONGO_HOST=
MONGO_PORT=
MONGO_USER=
MONGO_PASS=
MONGO_DATABASE=
```
For initialization `MongoConfig` config.
add below example code in `config/main.go`
```go
import (
...
...
...
. "github.com/shipu/artifact"
)
```
```go
func Register() {
...
...
Config.AddConfig("NoSql", new(MongoConfig)).Load()
}
func Boot() {
...
...
}
```
if you want to run something when application start, you can add anything in `Boot` function.
### To get config:
```go
Config.GetString("NoSql.Host")
```
Config Method List:
```go
GetString("key")
GetInt("key")
Get("key")
```
## Route
Suppose example route is `notice/routes/api.go`:
```go
package routes
import (
. "github.com/shipu/artifact"
c "github.com/shipu/golang-gin-boilerplate/src/notice/controllers"
)
func Setup() {
v1 := Router.Group("api/v1")
v1.GET("notices", c.NoticeIndex())
v1.POST("notices", c.NoticeCreate())
v1.GET("notices/:noticeId", c.NoticeShow())
v1.PUT("notices/:noticeId", c.NoticeUpdate())
v1.DELETE("notices/:noticeId", c.NoticeDelete())
}
```
For Register example route. in `routes/main.go`
```go
import (
...
...
...
noticeRoute "github.com/shipu/golang-gin-boilerplate/src/notice/routes"
)
```
```go
func Register() {
...
...
noticeRoute.Setup()
}
```
## Response
In [Gin](https://github.com/gin-gonic/gin)
Where `c` is the `*gin.Context` context.
```go
data := map[string]interface{}{
"app": "Golang",
}
c.JSON(200, gin.H{
"status_code": 200,
"message": "Success",
"data": data,
})
```
In artifact boilerplate, you can use `Res`.
```go
data := map[string]interface{}{
"app": "Golang",
}
Res.Code(200).
Message("Success").
Data(data).
Json(c)
```
`Res` Api Methods:
```go
Json
PureJSON
JsonP
AsciiJSON
IndentedJSON
Html
Xml
Yaml
ProtoBuf
AbortWithStatusJSON
Abort
AbortWithError
Redirect
```
## Mongo Collection
```go
var TodoCollection artifact.MongoCollection = artifact.Mongo.Collection("todos")
TodoCollection.Find(bson.M{})
```
All [Go Mongo Driver](https://docs.mongodb.com/drivers/go/current/) Support.
近期下载者：
相关文件：
收藏者：