Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d-alejandro/go-code-examples
Go, Clean Architecture, SOLID, Golang 1.21, Gin Web Framework, Delve Debugging Mode, GORM, Goose, Logrus, Viper, Dependency Injection, RESTful API, PostgreSQL 16, CRUD, DTO, MVC, Docker Compose, SQL, Design Patterns
https://github.com/d-alejandro/go-code-examples
clean-architecture crud debugging delve dependency-injection design-patterns docker dto gin go golang goose gorm logrus mvc postgresql rest-api solid sql viper
Last synced: about 1 month ago
JSON representation
Go, Clean Architecture, SOLID, Golang 1.21, Gin Web Framework, Delve Debugging Mode, GORM, Goose, Logrus, Viper, Dependency Injection, RESTful API, PostgreSQL 16, CRUD, DTO, MVC, Docker Compose, SQL, Design Patterns
- Host: GitHub
- URL: https://github.com/d-alejandro/go-code-examples
- Owner: d-alejandro
- Created: 2023-10-28T16:17:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T15:17:23.000Z (7 months ago)
- Last Synced: 2024-05-22T16:12:25.857Z (7 months ago)
- Topics: clean-architecture, crud, debugging, delve, dependency-injection, design-patterns, docker, dto, gin, go, golang, goose, gorm, logrus, mvc, postgresql, rest-api, solid, sql, viper
- Language: Go
- Homepage:
- Size: 134 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Go Code Examples
## Topics
- Back-end
- Clean Architecture
- CRUD
- Debugging Mode
- [Delve](https://github.com/go-delve/delve)
- Dependency Injection
- Design Patterns
- Docker Compose
- Dockerfile with multi-stage builds
- DTO
- [Gin Web Framework](https://github.com/gin-gonic/gin)
- Golang 1.21
- [Goose](https://github.com/pressly/goose)
- [GORM](https://github.com/go-gorm/gorm)
- Linux
- [Logrus](https://github.com/sirupsen/logrus)
- Makefile
- MVC
- PostgreSQL 16
- RESTful API
- SOLID
- SQL
- [Viper](https://github.com/spf13/viper)
## Installation
1. Clone this repository:
```
git clone [email protected]:d-alejandro/go-code-examples.git
```
2. Go to `go-code-examples` directory:
```
cd go-code-examples
```
3. Create a new .env file:
```
cp .env.example .env
```
4. Download and install `Go` SDK `1.21.6`.
5. Build and run the application:
```
make run
```
or
```
make
```
6. Start the debugging process in the IDE with `Go Remote` configuration.
```
Host: localhost
Port: 7000
```
7. Apply migrations:
```
make migrate
```
## API Endpoints
### All Orders with pagination
- Request URL: `http://localhost:8080/api/orders?start=0&end=1&sort_column=id&sort_type=asc`
- Method: `GET`
- Path: `/orders`
- Headers: `Accept:application/json, Content-Type:application/json`
- Parameters: `start, end, sort_column, sort_type`
- Status Code: `200`
- Response:
```json
{
"data": [
{
"id": 10000001,
"agency_name": "ОАО ITНефтьРыбОпт",
"status": "waiting",
"is_confirmed": false,
"is_checked": false,
"rental_date": "31-12-2023",
"user_name": "Валерия Фёдоровна Вишнякова",
"transport_count": 3,
"guest_count": 3,
"admin_note": null
}
]
}
```
### Create Order
- Request URL: `http://localhost:8080/api/orders`
- Method: `POST`
- Path: `/orders`
- Headers: `Accept:application/json, Content-Type:application/json`
- Parameters: `agency_name, rental_date, guest_count, transport_count, user_name, email, phone`
- Status Code: `200`
- Response:
```json
{
"data": {
"id": 10000011,
"agency_name": "Test Agency Name",
"status": "waiting",
"is_confirmed": false,
"is_checked": false,
"rental_date": "01-02-2024",
"user_name": "Test User Name",
"transport_count": 1,
"guest_count": 1,
"admin_note": "",
"note": "",
"email": "[email protected]",
"phone": "71437854547",
"confirmed_at": null,
"created_at": "31-01-2024 22:11:14",
"updated_at": "31-01-2024 22:11:14"
}
}
```
### Order Details
- Request URL: `http://localhost:8080/api/orders/10000011`
- Method: `GET`
- Path: `/orders/{id}`
- Headers: `Accept:application/json, Content-Type:application/json`
- Status Code: `200`
- Response:
```json
{
"data": {
"id": 10000011,
"agency_name": "Test Agency Name",
"status": "waiting",
"is_confirmed": false,
"is_checked": false,
"rental_date": "01-02-2024",
"user_name": "Test User Name",
"transport_count": 1,
"guest_count": 1,
"admin_note": "",
"note": "",
"email": "[email protected]",
"phone": "71437854547",
"confirmed_at": null,
"created_at": "31-01-2024 22:11:15",
"updated_at": "31-01-2024 22:11:15"
}
}
```
### Update Order
- Request URL: `http://localhost:8080/api/orders/10000011`
- Method: `PUT`
- Path: `/orders/{id}`
- Headers: `Accept:application/json, Content-Type:application/json`
- Parameters: `guest_count, transport_count, user_name, email, phone`
- Status Code: `200`
- Response:
```json
{
"data": {
"id": 10000011,
"agency_name": "Test Agency Name",
"status": "waiting",
"is_confirmed": false,
"is_checked": false,
"rental_date": "01-02-2024",
"user_name": "Test7",
"transport_count": 7,
"guest_count": 7,
"admin_note": "qq",
"note": "ww",
"email": "[email protected]",
"phone": "71111111111",
"confirmed_at": null,
"created_at": "31-01-2024 22:11:15",
"updated_at": "31-01-2024 22:17:47"
}
}
```
### Delete Order
- Request URL: `http://localhost:8080/api/orders/10000011`
- Method: `DELETE`
- Path: `/orders/{id}`
- Headers: `Accept:application/json, Content-Type:application/json`
- Status Code: `200`
- Response:
```json
{
"data": {
"id": 10000011,
"agency_name": "Test Agency Name",
"status": "waiting",
"is_confirmed": false,
"is_checked": false,
"rental_date": "01-02-2024",
"user_name": "Test7",
"transport_count": 7,
"guest_count": 7,
"admin_note": "qq",
"note": "ww",
"email": "[email protected]",
"phone": "71111111111",
"confirmed_at": null,
"created_at": "31-01-2024 22:11:15",
"updated_at": "31-01-2024 22:17:47"
}
}
```