https://github.com/whalelogic/restgo
A lightweight, production-ready RESTful Employee API built with Go using the native standard library and backed by Redis/Valkey.
https://github.com/whalelogic/restgo
api employees golang json redis restful starter-kit template valkey yaml
Last synced: 1 day ago
JSON representation
A lightweight, production-ready RESTful Employee API built with Go using the native standard library and backed by Redis/Valkey.
- Host: GitHub
- URL: https://github.com/whalelogic/restgo
- Owner: whalelogic
- Created: 2026-06-07T13:34:10.000Z (5 days ago)
- Default Branch: main
- Last Pushed: 2026-06-07T15:09:04.000Z (5 days ago)
- Last Synced: 2026-06-07T16:20:03.005Z (5 days ago)
- Topics: api, employees, golang, json, redis, restful, starter-kit, template, valkey, yaml
- Language: Go
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Employee API 👨💼👩⚕️👨🏽🏭
A lightweight RESTful API for managing employee records built with **Go** (standard library `net/http`) and **Redis**.
Repository: `github.com/whalelogic/restgo`
## Environment Variables
| Variable | Description | Default Value |
| :--- | :--- | :--- |
| `REDIS_ADDR` | Network address (host:port) of the Redis instance | `localhost:6379` |
### Setting the Environment Variable (macOS & Linux)
```bash
# Inline execution
REDIS_ADDR="127.0.0.1:6379" go run main.go
# Session-wide export
export REDIS_ADDR="127.0.0.1:6379"
```
## API Endpoints Reference
The service listens on port `:8080`.
| Method | Endpoint | Description |
| :--- | :--- | :--- |
| `GET` | `/employees` | List all employees |
| `GET` | `/employees/{id}` | Get employee by ID |
| `POST` | `/employees` | Create a new employee |
| `PUT` | `/employees/{id}` | Fully update/replace an employee |
| `PATCH` | `/employees/{id}` | Partially update an employee |
| `DELETE` | `/employees/{id}` | Delete an employee |
## cURL Examples
### 1. Get All Employees
Bash
```
curl -X GET http://localhost:8080/employees
```
### 2. Get Employee by ID
Bash
```
curl -X GET http://localhost:8080/employees/emp_01J8
```
### 3. Create Employee
Bash
```
curl -X POST http://localhost:8080/employees \
-H "Content-Type: application/json" \
-d '{"name": "Alex Smith", "role": "DevOps", "email": "alex@example.com"}'
```
### 4. Update Employee (Full Replacement)
Bash
```
curl -X PUT http://localhost:8080/employees/emp_01J8 \
-H "Content-Type: application/json" \
-d '{"name": "Alex Smith", "role": "Lead DevOps", "email": "alex@example.com"}'
```
### 5. Patch Employee (Partial Update)
Bash
```
curl -X PATCH http://localhost:8080/employees/emp_01J8 \
-H "Content-Type: application/json" \
-d '{"role": "Principal DevOps"}'
```
### 6. Delete Employee
Bash
```
curl -X DELETE http://localhost:8080/employees/emp_01J8
```
## Internal Routing Architecture
The routing maps directly to the `employee.EmployeeHandler` struct via Go's native standard library routing:
Go
```
mux := http.NewServeMux()
mux.HandleFunc("GET /employees", h.List)
mux.HandleFunc("GET /employees/{id}", h.Get)
mux.HandleFunc("POST /employees", h.Create)
mux.HandleFunc("PUT /employees/{id}", h.Update)
mux.HandleFunc("PATCH /employees/{id}", h.Patch)
mux.HandleFunc("DELETE /employees/{id}", h.Delete)
```