https://github.com/hsavoye/rest-starter-template
Une API REST modulaire en Go avec Gorilla Mux et PostgreSQL. Parfait pour apprendre ou démarrer un backend rapide en Go.
https://github.com/hsavoye/rest-starter-template
backend go gorilla postgresql rest-api
Last synced: about 2 months ago
JSON representation
Une API REST modulaire en Go avec Gorilla Mux et PostgreSQL. Parfait pour apprendre ou démarrer un backend rapide en Go.
- Host: GitHub
- URL: https://github.com/hsavoye/rest-starter-template
- Owner: hsavoye
- Created: 2025-07-02T12:21:55.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-02T12:59:54.000Z (12 months ago)
- Last Synced: 2025-07-02T13:41:08.774Z (12 months ago)
- Topics: backend, go, gorilla, postgresql, rest-api
- Language: Go
- Homepage:
- Size: 28.3 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go Articles API
Ce projet est une API REST écrite en Go, utilisant le routeur Gorilla Mux et une base de données PostgreSQL. Elle permet de gérer une collection d’articles via des opérations de base (GET, POST). C’est un bon point de départ pour construire une API modulaire en Go.
## Fonctionnalités
- API REST en Go
- Récupération et création d’articles
- Routage avec Gorilla Mux
- Connexion PostgreSQL
- Configuration par fichier `.env`
- Architecture claire et modulaire
## Structure du projet
```
serv/
├── db/
└── db.go → Connexion à la db
├── handlers/
└── routes.go → Fonctions des routes HTTP (Get,Post)
├── models/
└── article.go → Structure des articles
├── .env → Variables pour accéder db
├── go.mod
└── main.go → Point entrée de l'app
````
## Configuration
**Attention à bien configurer votre BDD PostgreSQL dans pgAdmin4 (Port, User, Password).**
Crée un fichier `.env` à la racine du projet avec les variables suivantes : (en fonction de votre bdd Postgres)
```env
DB_USER=postgres
DB_PASSWORD=yourpassword
DB_NAME=postgres
DB_HOST=localhost
DB_PORT=5432
DB_SSLMODE=disable
````
Ces variables seront chargées automatiquement au lancement de l’application.
## Installation
1. Clone le dépôt :
```bash
git clone https://github.com/hsavoye/rest-starter-template.git
```
2. Installe les dépendances :
```bash
cd go-articles-api
```
```bash
go mod tidy
```
## Lancer le serveur
```bash
go run main.go
```
Le serveur démarrera sur `http://localhost:8081`
## Endpoints disponibles
| Méthode | URL | Description |
| ------: | --------- | -------------------------- |
| GET | `/` | Message d’accueil |
| GET | `/get` | Récupère tous les articles |
| POST | `/create` | Crée un nouvel article |
## Test rapide avec curl
```bash
# Créer un article (Windows)
curl -X POST http://localhost:8081/create -H "Content-Type: application/json" -d "{\"title\": \"Nouveau contenu\"}"
# Lister les articles (Windows)
curl http://localhost:8081/articles
```
## Dépendances principales
* [Go](https://golang.org/)
* [Gorilla Mux](https://github.com/gorilla/mux)
* [PostgreSQL](https://www.postgresql.org/)
* [joho/godotenv](https://github.com/joho/godotenv)