go-rest-api

command module
v0.0.0-...-c35fd87 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 3, 2022 License: MIT Imports: 8 Imported by: 0

README

Go Gin Boilerplate

A boilerplate for RESTful API with Golang, Gin and PostgresSQL

Go Version License

Golang Gin boilerplate with Postgres database resource. Supports multiple configuration environments.

Installation

First, you need to implement your own environment by copying .example.env into .env. Then replacing with your own database's information.

cp .env.example .env

Run in your terminal:

go run main.go

Usage example

Example call:

  • API url: http://localhost:8080/api/v1/{apiEndpoint}
  • Swagger UI url: http://localhost:8080/swagger/index.html#/

Release History

  • version 0.0.1

    • Configuration by environment,
    • Authentication
    • Entities: User, Token, Question, Score board
  • version 1.0.1

    • Add document
    • Implement swagger UI for endpoints's testing

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL