Site icon Golang Libraries, Apps, Golang Jobs and Go Tutorials

Generate boilerplate for Gin / Fiber / Echo / Chi Golang REST servers

Generate Golang Rest Server:

from one config file.



  1. Either create a custom config file with the frontend editor or copy one of the config file from examples dir
  2. Install gomarvin
# go version >= 1.17
go install

# go version < 1.17
go get

# or clone the repo and run go run main.go
git clone
  1. run gomarvin
# run this in the same dir as the config file, if the name of the config is "gomarvin.json"
gomarvin generate

# run this if custom config file name or path
gomarvin -config="PATH_TO_CONFIG" generate

# or generate only the typescript API client file. Useful if you want to generate fetch
# functions for a pre-existing REST API in a fast way.
gomarvin -fetch-only="true" generate
  1. run lower commands
go mod tidy
go mod download
go run main.go


  -config		Specify path to the gomarvin config file (default "gomarvin.json")
  -dangerous-regen	Regenerate everything. If set to true, init server will be regenerated and all previous changes will be lost (default "false")
  -fetch-only		generate only the typescript file that holds fetch function (default "false")`

Generated Typescript fetch functions usage example

// import the generated file
import * as F from "../../../chi_with_modules/public/gomarvin.gen" 
// or just import a single fetch function
import { GetUserById } from "../../../chi_with_modules/public/gomarvin.gen"

// either use the default client created from
// the settings of the config file, or create a new one
// (useful when switching environments)
const defaultClient = F.defaultClient

// api client when deployed
const productionClient: F.Client = {
  host_url: "",
  api_prefix: "/api/v1",
  headers: {
    "Content-type": "application/json;charset=UTF-8",

const DEV_MODE = true

// switch to productionClient if DEV_MODE is false
const client = DEV_MODE ? defaultClient : productionClient

// fetch GetUserById endpoint
async function FetchGetUsersById() {
  const res = await F.GetUserById(client, 10);

// append optional string to the existing endpoint url
async function FetchEndpointWithAppendedUrl() {
  const res = await F.GetUserById(client, 10, { append_url: "?name=jim" });

// define custom options for the fetch request
async function FetchEndpointWithCustomOptions() {
  const res = await F.GetUserById(client, 10, { options: { method: "POST" } });

// Use both optional values
// - append a string to the fetch url
// - define a new options object used in the fetch request
async function FetchWithAppendedUrlAndCustomOptions() {
  const res = await F.GetUserById(client, 10, {
    options: { method: "DELETE" },
    append_url: "?name=jim",


Credits to used packages

Not installed locally to avoid any dependencies.

Note on versioning

Versions (tags) have a pattern of x.y.z

For example, updating from 0.1.0 to 0.1.1 does not break anything. Going from 0.2.0 to 0.3.0 will break stuff.

Exit mobile version