README
¶
MyGram REST API
Hacktiv8 Scalable Web Service with Go - Final Project
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
- govalidator
- swaggo
- gin upload file
- cloudinary go upload file
- cloudinary go example
- cloudinary destroy file
- go live reload (air)
- example docker setup with go
- Makefile .PHONY
Dependencies
go get github.com/asaskevich/govalidatorgo get github.com/golang-jwt/jwt/v5go get github.com/gin-gonic/gingo get golang.org/x/cryptogo get gorm.io/driver/postgresgo get gorm.io/gormgo get github.com/joho/godotenvgo get github.com/swaggo/swag/cmd/swaggo get github.com/swaggo/gin-swaggergo get github.com/swaggo/filesgo get github.com/google/uuidgo get github.com/cloudinary/cloudinary-go/v2go get github.com/cloudinary/cloudinary-go/v2/api/uploadergo get github.com/stretchr/testify
Setup DB (Postgres)
- Login psql:
psql -U postgres - Show databases:
\listor\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 startorairfor 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
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
Code generated by swaggo/swag.
|
Code generated by swaggo/swag. |
|
internal
|
|
Click to show internal directories.
Click to hide internal directories.