https://github.com/bodo-hugo-barwich/gin-blog_api

Small Blog API with Gin and Gorm
https://github.com/bodo-hugo-barwich/gin-blog_api

api-rest blog gin-gonic go golang gorm

Last synced: about 1 month ago
JSON representation

Small Blog API with Gin and Gorm

• Host: GitHub
• URL: https://github.com/bodo-hugo-barwich/gin-blog_api
• Owner: bodo-hugo-barwich
• Created: 2024-07-30T05:40:08.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-16T05:37:04.000Z (2 months ago)
• Last Synced: 2024-09-26T20:05:27.853Z (about 2 months ago)
• Topics: api-rest, blog, gin-gonic, go, golang, gorm
• Language: Go
• Homepage:
• Size: 8.55 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Testing against Compiler Versions](https://github.com/bodo-hugo-barwich/gin-blog_api/actions/workflows/compiler-versions.yml/badge.svg)](https://github.com/bodo-hugo-barwich/gin-blog_api/actions/workflows/compiler-versions.yml)

# NAME

Gin Blog API

# DESCRIPTION

This a **REST API** that manages _User_ and _Article_ entities.

It also features a **JWT** admin authentication.

This API is meant to be consumed by a frontend to give it a graphical interface.

# REQUIREMENTS

To rebuild this web site the tested **Minimum Go Compiler Version** is _Go_ `1.19`.\

The site uses the libraries `Gin`, `Gorm` and `golang-jwt`.\

The _Gin_ Web Server uses the _Gorm_ framework for the database access.\

At the moment only _PostgreSQL_ is supported as database backend.\

The server responses are provided as `JSON` documents.

# INSTALLATION

- **go**

The `go` command will install the dependencies on local user level as they

are found in the `go.mod` file.

# CONFIGURATION

- `.env`

The a `.env` file contains the basic configuration for the service.\

A fallback system looks first for the `.env` file corresponding to the `GIN_MODE` like

`.env.test` or `.env.debug` and then falls back to the default `.env` file

if the dedicated file not exists.\

The `.env_sample` can be copied and configured to build a configuration file.

# EXECUTION

- `go run .`

The Site can be launched using the `go run` command.

To launch the Site call the `go run` command within the project directory:

            go run .

# IMPLEMENTATION

- **API-First Design**

To be modular and extendable the **API-First** design was chosen.

So, this API is meant to be combined with a web site which will give a grafical interface to the information stored in the API.