Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/faysal-ishtiaq/genesis
opinionated API scaffolding tool using gin-gonic, gorm
https://github.com/faysal-ishtiaq/genesis
Last synced: 2 days ago
JSON representation
opinionated API scaffolding tool using gin-gonic, gorm
- Host: GitHub
- URL: https://github.com/faysal-ishtiaq/genesis
- Owner: faysal-ishtiaq
- License: mit
- Created: 2020-06-01T05:30:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-08T06:12:43.000Z (over 3 years ago)
- Last Synced: 2024-03-22T08:59:31.450Z (10 months ago)
- Language: Go
- Size: 48.8 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Genesis
An opinionated API scaffolding tool using gorm and gin-gonic
## Contents
- [Genesis](#genesis)
- [Contents](#contents)
- [Get Started](#get-started)
- [About](#about)
- [Example](#example)
## Get Started
```bash
$ 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
```bash
$ 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
```bash
$ 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:
```go
todo.InitDB(db)
```
before `return db` statement.
in main.go/main(), write:
```go
todo.BindRoutes(db, router)
```
before
```go
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:
```go
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
```go
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
```go
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)`:
```go
task.Title = taskDTO.Title
task.Done = taskDTO.Done
```
and you're done. Now run `go run main.go` and your API is up!