faysal-ishtiaq/genesis

opinionated API scaffolding tool using gin-gonic, gorm

Genesis

An opinionated API scaffolding tool using gorm and gin-gonic

Contents

• Genesis
  • Contents
  • Get Started
  • About
  • Example

Get Started

$ go get https://github.com/faysal-ishtiaq/genesis
$ mkdir appName
$ cd appName
$ genesis init -n appName -e sqlite
$ go generate # to install dependencies and intializing go module
$ genesis add -s serviceName

Then add serviceName.InitDB() in initDB() function of main.go, add serviceName.BindRoutes() in main function in main.go, change model.go, dto.go, api.go the way you want it!

About

$ genesis help
Automate the boring parts of API development while not compromising with quality and scalability.

Usage:
  genesis [command]

Available Commands:
  add         Adds a new service to your API
  help        Help about any command
  init        Initialize a REST API Project

Flags:
      --config string   config file (default is $HOME/.genesis.yaml)
  -h, --help            help for genesis
  -t, --toggle          Help message for toggle

Use "genesis [command] --help" for more information about a command.


$ genesis init --help
Initializes a REST API project using gin-gonic as http handler and gorm as orm.

Usage:
  genesis init [flags]

Flags:
  -n, --app-name string    Package name for your API
  -e, --db-engine string   Database Engine for your API. Accepted values are - mysql, pgsql, mssql, sqlite (default "mysql")
  -h, --help               help for init

Global Flags:
      --config string   config file (default is $HOME/.genesis.yaml)


$ genesis add --help
This command generates the following file structure in a directory named after your service name.
serviceName:
|- model.go
|- dto.go
|- mapper.go
|- repository.go
|- service.go
|- api.go
|- route.go
|- bootstrap.go

Usage:
  genesis add [flags]

Flags:
  -h, --help             help for add
  -m, --models strings   List of model names as a comma separated string. Model names will be converted to title case
  -s, --service string   Name of the Service to add to the API

Global Flags:
      --config string   config file (default is $HOME/.genesis.yaml)

Example

Let's build a test app with Todo service

$ mkdir test && cd test
$ cd test
$ genesis init -n test -e sqlite
$ go generate
$ genesis add -s todo -m task

Now, we have to add our service in main.go

in main.go/initDB(), write:

todo.InitDB(db)

before return db statement.

in main.go/main(), write:

todo.BindRoutes(db, router)

before

	err := router.Run()
	if err != nil {
		panic(err)
    }

Now, our Task model in our todo service might have a task tile and status to show if it's done.

modify todo/model.go like following:

package todo

import "github.com/jinzhu/gorm"

type Task struct {
	gorm.Model
	Title string
	Done  bool
}

Note: don't panic! you just have to write Title string and Done bool

Update todo/dto.go like following

package todo

type TaskDTO struct {
	ID    uint `json:"id,string,omitempty"`
	Title string `json:"title"`
	Done  bool `json:"done"`
}

Then update ToTask and ToTaskDTO function in todo/mapper.go like follwoing

func ToTask(taskDTO TaskDTO) Task {
	return Task{
		Title: taskDTO.Title,
		Done:  taskDTO.Done,
	}
}

func ToTaskDTO(task Task) TaskDTO {
	return TaskDTO{
		Title: task.Title,
		Done:  task.Done,
	}
}

One last step. In your todo/api.go add these lines before todo.TodoService.SaveTask(task):

	task.Title = taskDTO.Title
	task.Done = taskDTO.Done

and you're done. Now run go run main.go and your API is up!