gomakeme

Generate boilerplate + endpoints for Fiber or Gin REST APIs.

Table of contents

Install
Generate the REST API
Explanation
Config file
Notes

Install

# go version >= 1.17
go install github.com/tompston/gomakeme@latest

# go version < 1.17
go get github.com/tompston/gomakeme

# or clone the repo and run go run main.go
git clone https://github.com/tompston/gomakeme.git

Generate the REST API

Create the gomakeme.yml config file, copy example settings from this repo and update values
run gomakeme in the directory which holds the yaml config
cd into the created project and run

go mod tidy
go mod download
gofmt -s -w .
go run main.go
# + change the .env vars

Once generated, only the "router/project_modules.go" file will be updated on the next gomakeme runs. All of the other files won't be touched

Explanation

It seems like one of the boring / repetitive parts of writing basic REST APIs is the boilerpate for the endpoints.

Want to add a new table to the database and create endpoints for it? Before starting to do so, you need to write the new routes and controllers that deal with the common CRUD opetations.

Want to add another table? Repat the same process again, but change only the name to the new table.

So this stuff is boring and repetative. That's why you can automate it.

Config file

Commented out lines + modules lines are optional
All of the other lines are mandatory!

Currently there are three main options for the project that you could generate:

Minimal server with no endpoints
Server that uses modules
Server that uses modules + additional boilerplate for SQLC

* examples of all options can be found inside examples dir

The option you choose is based on the gomakeme.yml config file. If there are modules specified in the config file, they will be added to the project.

For example, if your config file has some defined modules, like

modules: [User, Task]

The user_module will be created in the modules directory.

sqlc: true

If true, then sqlc config files and sql files for modules will also be generated inside /db dir. The sql files that would be used by sqlc would include

table with the name of the module + 3 frequently used columns (id, created_at, updated_at)
5 CRUD queries with placeholder values

Additionaly a functions.sql file will be created that will hold a function that will be triggered once the db row is updated.

No migration tools included, SQLC documentation lists some possible options that could be used, so check them out and pick one that you like the most.

include_db_snippet: true

If true, includes a snippet inside the controllers that can create a connection to the database

Adding new modules

On each run the program checks if the module specified in the config file exists in the project_name/modules/ dir. If a new module is added in the modules array, it will be added to the generated server.

Module

A single module will hold 5 basic CRUD endpoints that will be automatically available to the server. The generated controllers are held in seperate files, where the name of the file indicates what type of http request is associated with it. The controllers can also hold common functions, such as

validation of url params, if there are any
validation and custom error messages for the sent payloads
database connection ( if set to true in the config file )

Once the directory for the user_module is created, it won't be updated if you run the gomakeme again, so you can edit them.

Notes

Taking a bit of inspiration from Nest.js, we bundle router + controllers into one package.
There are probably bugs. Somewhere

License

tompston/gomakeme

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 3

Packages 0

Uh oh!

Languages

Packages