Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alvinmdj/mygram-api
MyGram (Go REST API)
https://github.com/alvinmdj/mygram-api
cloudinary docker gin golang gorm jwt postgresql rest-api swagger test-automation
Last synced: 3 days ago
JSON representation
MyGram (Go REST API)
- Host: GitHub
- URL: https://github.com/alvinmdj/mygram-api
- Owner: alvinmdj
- License: mit
- Created: 2023-04-10T14:14:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-30T05:34:21.000Z (about 1 year ago)
- Last Synced: 2023-12-20T11:08:44.927Z (about 1 year ago)
- Topics: cloudinary, docker, gin, golang, gorm, jwt, postgresql, rest-api, swagger, test-automation
- Language: Go
- Homepage:
- Size: 402 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MyGram REST API
Hacktiv8 Scalable Web Service with Go - Final Project
- [Postman](https://documenter.getpostman.com/view/16534190/2s93XwzjHg)
Techs:
- Gin Framework
- JWT Authentication & Authorization
- PostgreSQL & GORM
- govalidation
- Swagger docs
- Cloudinary file upload
- testing & httptest & testify
## Swagger
## Endpoints
| Category | Method | Endpoint | Middleware | Description |
|--------------|--------|--------------------------------------|--------------------------------|---------------------------|
| User | POST | /api/v1/users/register | - | User registration |
| User | POST | /api/v1/users/login | - | User login |
| Photo | GET | /api/v1/photos | Authentication | Get all photos |
| Photo | GET | /api/v1/photos/:id | Authentication | Get photo by ID |
| Photo | POST | /api/v1/photos | Authentication | Create new photo |
| Photo | PUT | /api/v1/photos/:id | Authentication & Authorization | Update photo by ID |
| Photo | DELETE | /api/v1/photos/:id | Authentication & Authorization | Delete photo by ID |
| Comment | GET | /api/v1/photos/:photoId/comments | Authentication | Get all comments |
| Comment | GET | /api/v1/photos/:photoId/comments/:id | Authentication | Get comment by ID |
| Comment | POST | /api/v1/photos/:photoId/comments | Authentication | Create new comment |
| Comment | PUT | /api/v1/photos/:photoId/comments/:id | Authentication & Authorization | Update comment by ID |
| Comment | DELETE | /api/v1/photos/:photoId/comments/:id | Authentication & Authorization | Delete comment by ID |
| Social Media | GET | /api/v1/social-medias | Authentication | Get all social medias |
| Social Media | GET | /api/v1/social-medias/:id | Authentication | Get social media by ID |
| Social Media | POST | /api/v1/social-medias | Authentication | Create new social media |
| Social Media | PUT | /api/v1/social-medias/:id | Authentication & Authorization | Update social media by ID |
| Social Media | DELETE | /api/v1/social-medias/:id | Authentication & Authorization | Delete social media by ID |
## Links
- [gorm](https://gorm.io/)
- [govalidator](https://github.com/asaskevich/govalidator)
- [swaggo](https://github.com/swaggo/swag)
- [gin upload file](https://gin-gonic.com/docs/examples/upload-file/single-file/)
- [cloudinary go upload file](https://cloudinary.com/documentation/go_image_and_video_upload)
- [cloudinary go example](https://cloudinary.com/documentation/go_integration#complete_sdk_example)
- [cloudinary destroy file](https://cloudinary.com/documentation/image_upload_api_reference#destroy_method)
- [go live reload (air)](https://github.com/cosmtrek/air)
- [example docker setup with go](https://levelup.gitconnected.com/dockerized-crud-restful-api-with-go-gorm-jwt-postgresql-mysql-and-testing-61d731430bd8)
- [Makefile .PHONY](https://stackoverflow.com/questions/2145590/what-is-the-purpose-of-phony-in-a-makefile)
## Dependencies
- `go get github.com/asaskevich/govalidator`
- `go get github.com/golang-jwt/jwt/v5`
- `go get github.com/gin-gonic/gin`
- `go get golang.org/x/crypto`
- `go get gorm.io/driver/postgres`
- `go get gorm.io/gorm`
- `go get github.com/joho/godotenv`
- `go get github.com/swaggo/swag/cmd/swag`
- `go get github.com/swaggo/gin-swagger`
- `go get github.com/swaggo/files`
- `go get github.com/google/uuid`
- `go get github.com/cloudinary/cloudinary-go/v2`
- `go get github.com/cloudinary/cloudinary-go/v2/api/uploader`
- `go get github.com/stretchr/testify`
## Setup DB (Postgres)
- Login psql: `psql -U postgres`
- Show databases: `\list` or `\l`
- Create database: `CREATE DATABASE db_mygram_api;` & `CREATE DATABASE db_mygram_api_test;`
- Select database: `\c db_mygram_api`
- Show tables: `dt`
## Setup env
- Copy `cp .env.example .env`
- Setup environment variables
## Init swagger docs
- using Makefile: `make swagger`
During local development, swagger docs available at: `http://localhost:8080/swagger/index.html`
## Run test
- using Makefile: `make test`
## Run app
- local development: `make start` or `air` for live reload
- or using Docker: `docker compose up`
## Build app
- using Makefile: `make build`
Build result at `/bin/mygram-api.exe`
## Create random string
`openssl rand -base64 32`
## DB Schema
