go-gin-rest

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

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

Go to latest
Published: Nov 26, 2024 License: MIT Imports: 7 Imported by: 0

README

Go Gin REST starter

GitHub Actions workflow status badge codebeat badge

A backend starter project for implementing REST APIs in Go and using Gin framework, including:

  • Gin as web framework
  • PostgreSQL as database
  • GORM for ORM (object–relational mapping)
  • ULID (Universally Unique Lexicographically Sortable Identifier) for IDs
  • A devcontainer with dependencies that can be used with VS Code or independently with docker compose

The starter example implements the following endpoints:

GET /v1/albums
POST /v1/albums
PUT /v1/albums
GET /v1/albums/:id
DELETE /v1/albums/:id

TODO:

  • Logging
  • JSON validation
  • OpenAPI/Swagger
  • API request examples in the repo with Bruno
  • Mock generation from interfaces
  • Add unit tests

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
db
pkg
id

Jump to

Keyboard shortcuts

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