Go Rest API Documentation

Table Of Content

• Prerequisite
  • Spesification
  • Layout
• How To
• References
  • GIT style

Prerequisites

What things you need to setup the application:

Spesification

This application uses:

• Gin
• Gorm
• PostgreSQL

Layout

.
└── cmd
|   ├── migration
|   |   └── migration.go
|   └── main.go
├── config
|   ├── db
|   |   ├── db.go
|   |   └── postgresql.go
|   ├── cors.go
|   └── routers.go
├── internal
|   ├── contoller
|   |   ├── article
|   |   │   └── article.go
|   |   ├── root
|   |   │   └── root.go
|   |   └── user
|   |       └── auth.go
|   ├── domain
|   │   ├── article
|   │   │   ├── model
|   │   │   │   ├── article_request.go
|   │   │   │   ├── article_response.go
|   │   │   │   └── article.go
|   │   │   ├── repository
|   │   │   │   └── article.go
|   │   │   └── service
|   │   │       └── article.go
|   │   └── user
|   │       ├── model
|   │       │   ├── user_request.go
|   │       │   ├── user_response.go
|   │       │   └── user.go
|   │       ├── repository
|   │       │   └── user.go
|   │       └── service
|   │           └── user.go
|   ├── middleware
|   │   └── auth.go
|   └── router
|       └── main.go
├── lib
|   ├── auth
|   │   └── context.go
|   ├── constant
|   │   └── error.go
|   ├── encrypt
|   │   └── encrypt.go
|   ├── env
|   │   └── env.go
|   └── response
|       └── response.go
├── .env.example
├── .gitignore
├── go.mod
├── go.sum
├── LICENSE
├── Makefile
└── README.md

How To

Running The App

• First get the dependencies with this command:

make mod

• Copy the .env.example to .env with run this command:

make env

• for migrate database schema use this command:

make migration

• and for running the application can use this command:

make run

References

GIT Style

For commit message style or git style guide, use this doc

• Conventional Commits